Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-compute-profile-2019-03-01-hybrid

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AccessLevel

AccessLevel: "None" | "Read"

Defines values for AccessLevel. Possible values include: 'None', 'Read'

readonly
enum

{string}

AvailabilitySetsCreateOrUpdateResponse

AvailabilitySetsCreateOrUpdateResponse: AvailabilitySet & object

Contains response data for the createOrUpdate operation.

AvailabilitySetsDeleteMethodResponse

AvailabilitySetsDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

AvailabilitySetsGetResponse

AvailabilitySetsGetResponse: AvailabilitySet & object

Contains response data for the get operation.

AvailabilitySetsListAvailableSizesResponse

AvailabilitySetsListAvailableSizesResponse: VirtualMachineSizeListResult & object

Contains response data for the listAvailableSizes operation.

AvailabilitySetsListBySubscriptionNextResponse

AvailabilitySetsListBySubscriptionNextResponse: AvailabilitySetListResult & object

Contains response data for the listBySubscriptionNext operation.

AvailabilitySetsListBySubscriptionResponse

AvailabilitySetsListBySubscriptionResponse: AvailabilitySetListResult & object

Contains response data for the listBySubscription operation.

AvailabilitySetsListNextResponse

AvailabilitySetsListNextResponse: AvailabilitySetListResult & object

Contains response data for the listNext operation.

AvailabilitySetsListResponse

AvailabilitySetsListResponse: AvailabilitySetListResult & object

Contains response data for the list operation.

AvailabilitySetsUpdateResponse

AvailabilitySetsUpdateResponse: AvailabilitySet & object

Contains response data for the update operation.

CachingTypes

CachingTypes: "None" | "ReadOnly" | "ReadWrite"

Defines values for CachingTypes. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

readonly
enum

{string}

ComponentNames

ComponentNames: "Microsoft-Windows-Shell-Setup"

Defines values for ComponentNames. Possible values include: 'Microsoft-Windows-Shell-Setup'

readonly
enum

{string}

DiskCreateOption

DiskCreateOption: "Empty" | "Attach" | "FromImage" | "Import" | "Copy"

Defines values for DiskCreateOption. Possible values include: 'Empty', 'Attach', 'FromImage', 'Import', 'Copy'

readonly
enum

{string}

DiskCreateOptionTypes

DiskCreateOptionTypes: "FromImage" | "Empty" | "Attach"

Defines values for DiskCreateOptionTypes. Possible values include: 'FromImage', 'Empty', 'Attach'

readonly
enum

{string}

DisksBeginCreateOrUpdateResponse

DisksBeginCreateOrUpdateResponse: Disk & object

Contains response data for the beginCreateOrUpdate operation.

DisksBeginDeleteMethodResponse

DisksBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

DisksBeginGrantAccessResponse

DisksBeginGrantAccessResponse: AccessUri & object

Contains response data for the beginGrantAccess operation.

DisksBeginRevokeAccessResponse

DisksBeginRevokeAccessResponse: OperationStatusResponse & object

Contains response data for the beginRevokeAccess operation.

DisksBeginUpdateResponse

DisksBeginUpdateResponse: Disk & object

Contains response data for the beginUpdate operation.

DisksCreateOrUpdateResponse

DisksCreateOrUpdateResponse: Disk & object

Contains response data for the createOrUpdate operation.

DisksDeleteMethodResponse

DisksDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

DisksGetResponse

DisksGetResponse: Disk & object

Contains response data for the get operation.

DisksGrantAccessResponse

DisksGrantAccessResponse: AccessUri & object

Contains response data for the grantAccess operation.

DisksListByResourceGroupNextResponse

DisksListByResourceGroupNextResponse: DiskList & object

Contains response data for the listByResourceGroupNext operation.

DisksListByResourceGroupResponse

DisksListByResourceGroupResponse: DiskList & object

Contains response data for the listByResourceGroup operation.

DisksListNextResponse

DisksListNextResponse: DiskList & object

Contains response data for the listNext operation.

DisksListResponse

DisksListResponse: DiskList & object

Contains response data for the list operation.

DisksRevokeAccessResponse

DisksRevokeAccessResponse: OperationStatusResponse & object

Contains response data for the revokeAccess operation.

DisksUpdateResponse

DisksUpdateResponse: Disk & object

Contains response data for the update operation.

IPVersion

IPVersion: "IPv4" | "IPv6"

Defines values for IPVersion. Possible values include: 'IPv4', 'IPv6'

readonly
enum

{string}

ImagesBeginCreateOrUpdateResponse

ImagesBeginCreateOrUpdateResponse: Image & object

Contains response data for the beginCreateOrUpdate operation.

ImagesBeginDeleteMethodResponse

ImagesBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

ImagesBeginUpdateResponse

ImagesBeginUpdateResponse: Image & object

Contains response data for the beginUpdate operation.

ImagesCreateOrUpdateResponse

ImagesCreateOrUpdateResponse: Image & object

Contains response data for the createOrUpdate operation.

ImagesDeleteMethodResponse

ImagesDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

ImagesGetResponse

ImagesGetResponse: Image & object

Contains response data for the get operation.

ImagesListByResourceGroupNextResponse

ImagesListByResourceGroupNextResponse: ImageListResult & object

Contains response data for the listByResourceGroupNext operation.

ImagesListByResourceGroupResponse

ImagesListByResourceGroupResponse: ImageListResult & object

Contains response data for the listByResourceGroup operation.

ImagesListNextResponse

ImagesListNextResponse: ImageListResult & object

Contains response data for the listNext operation.

ImagesListResponse

ImagesListResponse: ImageListResult & object

Contains response data for the list operation.

ImagesUpdateResponse

ImagesUpdateResponse: Image & object

Contains response data for the update operation.

InstanceViewTypes

InstanceViewTypes: "instanceView"

Defines values for InstanceViewTypes. Possible values include: 'instanceView'

readonly
enum

{string}

IntervalInMins

IntervalInMins: "ThreeMins" | "FiveMins" | "ThirtyMins" | "SixtyMins"

Defines values for IntervalInMins. Possible values include: 'ThreeMins', 'FiveMins', 'ThirtyMins', 'SixtyMins'

readonly
enum

{string}

LogAnalyticsBeginExportRequestRateByIntervalResponse

LogAnalyticsBeginExportRequestRateByIntervalResponse: LogAnalyticsOperationResult & object

Contains response data for the beginExportRequestRateByInterval operation.

LogAnalyticsBeginExportThrottledRequestsResponse

LogAnalyticsBeginExportThrottledRequestsResponse: LogAnalyticsOperationResult & object

Contains response data for the beginExportThrottledRequests operation.

LogAnalyticsExportRequestRateByIntervalResponse

LogAnalyticsExportRequestRateByIntervalResponse: LogAnalyticsOperationResult & object

Contains response data for the exportRequestRateByInterval operation.

LogAnalyticsExportThrottledRequestsResponse

LogAnalyticsExportThrottledRequestsResponse: LogAnalyticsOperationResult & object

Contains response data for the exportThrottledRequests operation.

MaintenanceOperationResultCodeTypes

MaintenanceOperationResultCodeTypes: "None" | "RetryLater" | "MaintenanceAborted" | "MaintenanceCompleted"

Defines values for MaintenanceOperationResultCodeTypes. Possible values include: 'None', 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted'

readonly
enum

{string}

OperatingSystemStateTypes

OperatingSystemStateTypes: "Generalized" | "Specialized"

Defines values for OperatingSystemStateTypes. Possible values include: 'Generalized', 'Specialized'

readonly
enum

{string}

OperatingSystemTypes

OperatingSystemTypes: "Windows" | "Linux"

Defines values for OperatingSystemTypes. Possible values include: 'Windows', 'Linux'

readonly
enum

{string}

OperationsListResponse

OperationsListResponse: ComputeOperationListResult & object

Contains response data for the list operation.

PassNames

PassNames: "OobeSystem"

Defines values for PassNames. Possible values include: 'OobeSystem'

readonly
enum

{string}

ProtocolTypes

ProtocolTypes: "Http" | "Https"

Defines values for ProtocolTypes. Possible values include: 'Http', 'Https'

readonly
enum

{string}

ResourceIdentityType

ResourceIdentityType: "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None"

Defines values for ResourceIdentityType. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

readonly
enum

{string}

RollingUpgradeActionType

RollingUpgradeActionType: "Start" | "Cancel"

Defines values for RollingUpgradeActionType. Possible values include: 'Start', 'Cancel'

readonly
enum

{string}

RollingUpgradeStatusCode

RollingUpgradeStatusCode: "RollingForward" | "Cancelled" | "Completed" | "Faulted"

Defines values for RollingUpgradeStatusCode. Possible values include: 'RollingForward', 'Cancelled', 'Completed', 'Faulted'

readonly
enum

{string}

SettingNames

SettingNames: "AutoLogon" | "FirstLogonCommands"

Defines values for SettingNames. Possible values include: 'AutoLogon', 'FirstLogonCommands'

readonly
enum

{string}

SnapshotsBeginCreateOrUpdateResponse

SnapshotsBeginCreateOrUpdateResponse: Snapshot & object

Contains response data for the beginCreateOrUpdate operation.

SnapshotsBeginDeleteMethodResponse

SnapshotsBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

SnapshotsBeginGrantAccessResponse

SnapshotsBeginGrantAccessResponse: AccessUri & object

Contains response data for the beginGrantAccess operation.

SnapshotsBeginRevokeAccessResponse

SnapshotsBeginRevokeAccessResponse: OperationStatusResponse & object

Contains response data for the beginRevokeAccess operation.

SnapshotsBeginUpdateResponse

SnapshotsBeginUpdateResponse: Snapshot & object

Contains response data for the beginUpdate operation.

SnapshotsCreateOrUpdateResponse

SnapshotsCreateOrUpdateResponse: Snapshot & object

Contains response data for the createOrUpdate operation.

SnapshotsDeleteMethodResponse

SnapshotsDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

SnapshotsGetResponse

SnapshotsGetResponse: Snapshot & object

Contains response data for the get operation.

SnapshotsGrantAccessResponse

SnapshotsGrantAccessResponse: AccessUri & object

Contains response data for the grantAccess operation.

SnapshotsListByResourceGroupNextResponse

SnapshotsListByResourceGroupNextResponse: SnapshotList & object

Contains response data for the listByResourceGroupNext operation.

SnapshotsListByResourceGroupResponse

SnapshotsListByResourceGroupResponse: SnapshotList & object

Contains response data for the listByResourceGroup operation.

SnapshotsListNextResponse

SnapshotsListNextResponse: SnapshotList & object

Contains response data for the listNext operation.

SnapshotsListResponse

SnapshotsListResponse: SnapshotList & object

Contains response data for the list operation.

SnapshotsRevokeAccessResponse

SnapshotsRevokeAccessResponse: OperationStatusResponse & object

Contains response data for the revokeAccess operation.

SnapshotsUpdateResponse

SnapshotsUpdateResponse: Snapshot & object

Contains response data for the update operation.

StatusLevelTypes

StatusLevelTypes: "Info" | "Warning" | "Error"

Defines values for StatusLevelTypes. Possible values include: 'Info', 'Warning', 'Error'

readonly
enum

{string}

StorageAccountTypes

StorageAccountTypes: "Standard_LRS" | "Premium_LRS"

Defines values for StorageAccountTypes. Possible values include: 'Standard_LRS', 'Premium_LRS'

readonly
enum

{string}

UpgradeMode

UpgradeMode: "Automatic" | "Manual" | "Rolling"

Defines values for UpgradeMode. Possible values include: 'Automatic', 'Manual', 'Rolling'

readonly
enum

{string}

UpgradeOperationInvoker

UpgradeOperationInvoker: "Unknown" | "User" | "Platform"

Defines values for UpgradeOperationInvoker. Possible values include: 'Unknown', 'User', 'Platform'

readonly
enum

{string}

UpgradeState

UpgradeState: "RollingForward" | "Cancelled" | "Completed" | "Faulted"

Defines values for UpgradeState. Possible values include: 'RollingForward', 'Cancelled', 'Completed', 'Faulted'

readonly
enum

{string}

UsageListNextResponse

UsageListNextResponse: ListUsagesResult & object

Contains response data for the listNext operation.

UsageListResponse

UsageListResponse: ListUsagesResult & object

Contains response data for the list operation.

VirtualMachineEvictionPolicyTypes

VirtualMachineEvictionPolicyTypes: "Deallocate" | "Delete"

Defines values for VirtualMachineEvictionPolicyTypes. Possible values include: 'Deallocate', 'Delete'

readonly
enum

{string}

VirtualMachineExtensionImagesGetResponse

VirtualMachineExtensionImagesGetResponse: VirtualMachineExtensionImage & object

Contains response data for the get operation.

VirtualMachineExtensionImagesListTypesResponse

VirtualMachineExtensionImagesListTypesResponse: Array<VirtualMachineExtensionImage> & object

Contains response data for the listTypes operation.

VirtualMachineExtensionImagesListVersionsResponse

VirtualMachineExtensionImagesListVersionsResponse: Array<VirtualMachineExtensionImage> & object

Contains response data for the listVersions operation.

VirtualMachineExtensionsBeginCreateOrUpdateResponse

VirtualMachineExtensionsBeginCreateOrUpdateResponse: VirtualMachineExtension & object

Contains response data for the beginCreateOrUpdate operation.

VirtualMachineExtensionsBeginDeleteMethodResponse

VirtualMachineExtensionsBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

VirtualMachineExtensionsBeginUpdateResponse

VirtualMachineExtensionsBeginUpdateResponse: VirtualMachineExtension & object

Contains response data for the beginUpdate operation.

VirtualMachineExtensionsCreateOrUpdateResponse

VirtualMachineExtensionsCreateOrUpdateResponse: VirtualMachineExtension & object

Contains response data for the createOrUpdate operation.

VirtualMachineExtensionsDeleteMethodResponse

VirtualMachineExtensionsDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

VirtualMachineExtensionsGetResponse

VirtualMachineExtensionsGetResponse: VirtualMachineExtension & object

Contains response data for the get operation.

VirtualMachineExtensionsUpdateResponse

VirtualMachineExtensionsUpdateResponse: VirtualMachineExtension & object

Contains response data for the update operation.

VirtualMachineImagesGetResponse

VirtualMachineImagesGetResponse: VirtualMachineImage & object

Contains response data for the get operation.

VirtualMachineImagesListOffersResponse

VirtualMachineImagesListOffersResponse: Array<VirtualMachineImageResource> & object

Contains response data for the listOffers operation.

VirtualMachineImagesListPublishersResponse

VirtualMachineImagesListPublishersResponse: Array<VirtualMachineImageResource> & object

Contains response data for the listPublishers operation.

VirtualMachineImagesListResponse

VirtualMachineImagesListResponse: Array<VirtualMachineImageResource> & object

Contains response data for the list operation.

VirtualMachineImagesListSkusResponse

VirtualMachineImagesListSkusResponse: Array<VirtualMachineImageResource> & object

Contains response data for the listSkus operation.

VirtualMachinePriorityTypes

VirtualMachinePriorityTypes: "Regular" | "Low"

Defines values for VirtualMachinePriorityTypes. Possible values include: 'Regular', 'Low'

readonly
enum

{string}

VirtualMachineScaleSetExtensionsBeginCreateOrUpdateResponse

VirtualMachineScaleSetExtensionsBeginCreateOrUpdateResponse: VirtualMachineScaleSetExtension & object

Contains response data for the beginCreateOrUpdate operation.

VirtualMachineScaleSetExtensionsBeginDeleteMethodResponse

VirtualMachineScaleSetExtensionsBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

VirtualMachineScaleSetExtensionsCreateOrUpdateResponse

VirtualMachineScaleSetExtensionsCreateOrUpdateResponse: VirtualMachineScaleSetExtension & object

Contains response data for the createOrUpdate operation.

VirtualMachineScaleSetExtensionsDeleteMethodResponse

VirtualMachineScaleSetExtensionsDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

VirtualMachineScaleSetExtensionsGetResponse

VirtualMachineScaleSetExtensionsGetResponse: VirtualMachineScaleSetExtension & object

Contains response data for the get operation.

VirtualMachineScaleSetExtensionsListNextResponse

VirtualMachineScaleSetExtensionsListNextResponse: VirtualMachineScaleSetExtensionListResult & object

Contains response data for the listNext operation.

VirtualMachineScaleSetExtensionsListResponse

VirtualMachineScaleSetExtensionsListResponse: VirtualMachineScaleSetExtensionListResult & object

Contains response data for the list operation.

VirtualMachineScaleSetRollingUpgradesBeginCancelResponse

VirtualMachineScaleSetRollingUpgradesBeginCancelResponse: OperationStatusResponse & object

Contains response data for the beginCancel operation.

VirtualMachineScaleSetRollingUpgradesBeginStartOSUpgradeResponse

VirtualMachineScaleSetRollingUpgradesBeginStartOSUpgradeResponse: OperationStatusResponse & object

Contains response data for the beginStartOSUpgrade operation.

VirtualMachineScaleSetRollingUpgradesCancelResponse

VirtualMachineScaleSetRollingUpgradesCancelResponse: OperationStatusResponse & object

Contains response data for the cancel operation.

VirtualMachineScaleSetRollingUpgradesGetLatestResponse

VirtualMachineScaleSetRollingUpgradesGetLatestResponse: RollingUpgradeStatusInfo & object

Contains response data for the getLatest operation.

VirtualMachineScaleSetRollingUpgradesStartOSUpgradeResponse

VirtualMachineScaleSetRollingUpgradesStartOSUpgradeResponse: OperationStatusResponse & object

Contains response data for the startOSUpgrade operation.

VirtualMachineScaleSetSkuScaleType

VirtualMachineScaleSetSkuScaleType: "Automatic" | "None"

Defines values for VirtualMachineScaleSetSkuScaleType. Possible values include: 'Automatic', 'None'

readonly
enum

{string}

VirtualMachineScaleSetVMsBeginDeallocateResponse

VirtualMachineScaleSetVMsBeginDeallocateResponse: OperationStatusResponse & object

Contains response data for the beginDeallocate operation.

VirtualMachineScaleSetVMsBeginDeleteMethodResponse

VirtualMachineScaleSetVMsBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

VirtualMachineScaleSetVMsBeginPerformMaintenanceResponse

VirtualMachineScaleSetVMsBeginPerformMaintenanceResponse: OperationStatusResponse & object

Contains response data for the beginPerformMaintenance operation.

VirtualMachineScaleSetVMsBeginPowerOffResponse

VirtualMachineScaleSetVMsBeginPowerOffResponse: OperationStatusResponse & object

Contains response data for the beginPowerOff operation.

VirtualMachineScaleSetVMsBeginRedeployResponse

VirtualMachineScaleSetVMsBeginRedeployResponse: OperationStatusResponse & object

Contains response data for the beginRedeploy operation.

VirtualMachineScaleSetVMsBeginReimageAllResponse

VirtualMachineScaleSetVMsBeginReimageAllResponse: OperationStatusResponse & object

Contains response data for the beginReimageAll operation.

VirtualMachineScaleSetVMsBeginReimageResponse

VirtualMachineScaleSetVMsBeginReimageResponse: OperationStatusResponse & object

Contains response data for the beginReimage operation.

VirtualMachineScaleSetVMsBeginRestartResponse

VirtualMachineScaleSetVMsBeginRestartResponse: OperationStatusResponse & object

Contains response data for the beginRestart operation.

VirtualMachineScaleSetVMsBeginStartResponse

VirtualMachineScaleSetVMsBeginStartResponse: OperationStatusResponse & object

Contains response data for the beginStart operation.

VirtualMachineScaleSetVMsBeginUpdateResponse

VirtualMachineScaleSetVMsBeginUpdateResponse: VirtualMachineScaleSetVM & object

Contains response data for the beginUpdate operation.

VirtualMachineScaleSetVMsDeallocateResponse

VirtualMachineScaleSetVMsDeallocateResponse: OperationStatusResponse & object

Contains response data for the deallocate operation.

VirtualMachineScaleSetVMsDeleteMethodResponse

VirtualMachineScaleSetVMsDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

VirtualMachineScaleSetVMsGetInstanceViewResponse

VirtualMachineScaleSetVMsGetInstanceViewResponse: VirtualMachineScaleSetVMInstanceView & object

Contains response data for the getInstanceView operation.

VirtualMachineScaleSetVMsGetResponse

VirtualMachineScaleSetVMsGetResponse: VirtualMachineScaleSetVM & object

Contains response data for the get operation.

VirtualMachineScaleSetVMsListNextResponse

VirtualMachineScaleSetVMsListNextResponse: VirtualMachineScaleSetVMListResult & object

Contains response data for the listNext operation.

VirtualMachineScaleSetVMsListResponse

VirtualMachineScaleSetVMsListResponse: VirtualMachineScaleSetVMListResult & object

Contains response data for the list operation.

VirtualMachineScaleSetVMsPerformMaintenanceResponse

VirtualMachineScaleSetVMsPerformMaintenanceResponse: OperationStatusResponse & object

Contains response data for the performMaintenance operation.

VirtualMachineScaleSetVMsPowerOffResponse

VirtualMachineScaleSetVMsPowerOffResponse: OperationStatusResponse & object

Contains response data for the powerOff operation.

VirtualMachineScaleSetVMsRedeployResponse

VirtualMachineScaleSetVMsRedeployResponse: OperationStatusResponse & object

Contains response data for the redeploy operation.

VirtualMachineScaleSetVMsReimageAllResponse

VirtualMachineScaleSetVMsReimageAllResponse: OperationStatusResponse & object

Contains response data for the reimageAll operation.

VirtualMachineScaleSetVMsReimageResponse

VirtualMachineScaleSetVMsReimageResponse: OperationStatusResponse & object

Contains response data for the reimage operation.

VirtualMachineScaleSetVMsRestartResponse

VirtualMachineScaleSetVMsRestartResponse: OperationStatusResponse & object

Contains response data for the restart operation.

VirtualMachineScaleSetVMsStartResponse

VirtualMachineScaleSetVMsStartResponse: OperationStatusResponse & object

Contains response data for the start operation.

VirtualMachineScaleSetVMsUpdateResponse

VirtualMachineScaleSetVMsUpdateResponse: VirtualMachineScaleSetVM & object

Contains response data for the update operation.

VirtualMachineScaleSetsBeginCreateOrUpdateResponse

VirtualMachineScaleSetsBeginCreateOrUpdateResponse: VirtualMachineScaleSet & object

Contains response data for the beginCreateOrUpdate operation.

VirtualMachineScaleSetsBeginDeallocateResponse

VirtualMachineScaleSetsBeginDeallocateResponse: OperationStatusResponse & object

Contains response data for the beginDeallocate operation.

VirtualMachineScaleSetsBeginDeleteInstancesResponse

VirtualMachineScaleSetsBeginDeleteInstancesResponse: OperationStatusResponse & object

Contains response data for the beginDeleteInstances operation.

VirtualMachineScaleSetsBeginDeleteMethodResponse

VirtualMachineScaleSetsBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

VirtualMachineScaleSetsBeginPerformMaintenanceResponse

VirtualMachineScaleSetsBeginPerformMaintenanceResponse: OperationStatusResponse & object

Contains response data for the beginPerformMaintenance operation.

VirtualMachineScaleSetsBeginPowerOffResponse

VirtualMachineScaleSetsBeginPowerOffResponse: OperationStatusResponse & object

Contains response data for the beginPowerOff operation.

VirtualMachineScaleSetsBeginRedeployResponse

VirtualMachineScaleSetsBeginRedeployResponse: OperationStatusResponse & object

Contains response data for the beginRedeploy operation.

VirtualMachineScaleSetsBeginReimageAllResponse

VirtualMachineScaleSetsBeginReimageAllResponse: OperationStatusResponse & object

Contains response data for the beginReimageAll operation.

VirtualMachineScaleSetsBeginReimageResponse

VirtualMachineScaleSetsBeginReimageResponse: OperationStatusResponse & object

Contains response data for the beginReimage operation.

VirtualMachineScaleSetsBeginRestartResponse

VirtualMachineScaleSetsBeginRestartResponse: OperationStatusResponse & object

Contains response data for the beginRestart operation.

VirtualMachineScaleSetsBeginStartResponse

VirtualMachineScaleSetsBeginStartResponse: OperationStatusResponse & object

Contains response data for the beginStart operation.

VirtualMachineScaleSetsBeginUpdateInstancesResponse

VirtualMachineScaleSetsBeginUpdateInstancesResponse: OperationStatusResponse & object

Contains response data for the beginUpdateInstances operation.

VirtualMachineScaleSetsBeginUpdateResponse

VirtualMachineScaleSetsBeginUpdateResponse: VirtualMachineScaleSet & object

Contains response data for the beginUpdate operation.

VirtualMachineScaleSetsCreateOrUpdateResponse

VirtualMachineScaleSetsCreateOrUpdateResponse: VirtualMachineScaleSet & object

Contains response data for the createOrUpdate operation.

VirtualMachineScaleSetsDeallocateResponse

VirtualMachineScaleSetsDeallocateResponse: OperationStatusResponse & object

Contains response data for the deallocate operation.

VirtualMachineScaleSetsDeleteInstancesResponse

VirtualMachineScaleSetsDeleteInstancesResponse: OperationStatusResponse & object

Contains response data for the deleteInstances operation.

VirtualMachineScaleSetsDeleteMethodResponse

VirtualMachineScaleSetsDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkResponse

VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkResponse: RecoveryWalkResponse & object

Contains response data for the forceRecoveryServiceFabricPlatformUpdateDomainWalk operation.

VirtualMachineScaleSetsGetInstanceViewResponse

VirtualMachineScaleSetsGetInstanceViewResponse: VirtualMachineScaleSetInstanceView & object

Contains response data for the getInstanceView operation.

VirtualMachineScaleSetsGetOSUpgradeHistoryNextResponse

VirtualMachineScaleSetsGetOSUpgradeHistoryNextResponse: VirtualMachineScaleSetListOSUpgradeHistory & object

Contains response data for the getOSUpgradeHistoryNext operation.

VirtualMachineScaleSetsGetOSUpgradeHistoryResponse

VirtualMachineScaleSetsGetOSUpgradeHistoryResponse: VirtualMachineScaleSetListOSUpgradeHistory & object

Contains response data for the getOSUpgradeHistory operation.

VirtualMachineScaleSetsGetResponse

VirtualMachineScaleSetsGetResponse: VirtualMachineScaleSet & object

Contains response data for the get operation.

VirtualMachineScaleSetsListAllNextResponse

VirtualMachineScaleSetsListAllNextResponse: VirtualMachineScaleSetListWithLinkResult & object

Contains response data for the listAllNext operation.

VirtualMachineScaleSetsListAllResponse

VirtualMachineScaleSetsListAllResponse: VirtualMachineScaleSetListWithLinkResult & object

Contains response data for the listAll operation.

VirtualMachineScaleSetsListNextResponse

VirtualMachineScaleSetsListNextResponse: VirtualMachineScaleSetListResult & object

Contains response data for the listNext operation.

VirtualMachineScaleSetsListResponse

VirtualMachineScaleSetsListResponse: VirtualMachineScaleSetListResult & object

Contains response data for the list operation.

VirtualMachineScaleSetsListSkusNextResponse

VirtualMachineScaleSetsListSkusNextResponse: VirtualMachineScaleSetListSkusResult & object

Contains response data for the listSkusNext operation.

VirtualMachineScaleSetsListSkusResponse

VirtualMachineScaleSetsListSkusResponse: VirtualMachineScaleSetListSkusResult & object

Contains response data for the listSkus operation.

VirtualMachineScaleSetsPerformMaintenanceResponse

VirtualMachineScaleSetsPerformMaintenanceResponse: OperationStatusResponse & object

Contains response data for the performMaintenance operation.

VirtualMachineScaleSetsPowerOffResponse

VirtualMachineScaleSetsPowerOffResponse: OperationStatusResponse & object

Contains response data for the powerOff operation.

VirtualMachineScaleSetsRedeployResponse

VirtualMachineScaleSetsRedeployResponse: OperationStatusResponse & object

Contains response data for the redeploy operation.

VirtualMachineScaleSetsReimageAllResponse

VirtualMachineScaleSetsReimageAllResponse: OperationStatusResponse & object

Contains response data for the reimageAll operation.

VirtualMachineScaleSetsReimageResponse

VirtualMachineScaleSetsReimageResponse: OperationStatusResponse & object

Contains response data for the reimage operation.

VirtualMachineScaleSetsRestartResponse

VirtualMachineScaleSetsRestartResponse: OperationStatusResponse & object

Contains response data for the restart operation.

VirtualMachineScaleSetsStartResponse

VirtualMachineScaleSetsStartResponse: OperationStatusResponse & object

Contains response data for the start operation.

VirtualMachineScaleSetsUpdateInstancesResponse

VirtualMachineScaleSetsUpdateInstancesResponse: OperationStatusResponse & object

Contains response data for the updateInstances operation.

VirtualMachineScaleSetsUpdateResponse

VirtualMachineScaleSetsUpdateResponse: VirtualMachineScaleSet & object

Contains response data for the update operation.

VirtualMachineSizeTypes

VirtualMachineSizeTypes: "Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_A2m_v2" | "Standard_A4m_v2" | "Standard_A8m_v2" | "Standard_B1s" | "Standard_B1ms" | "Standard_B2s" | "Standard_B2ms" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D2_v3" | "Standard_D4_v3" | "Standard_D8_v3" | "Standard_D16_v3" | "Standard_D32_v3" | "Standard_D64_v3" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" | "Standard_D16s_v3" | "Standard_D32s_v3" | "Standard_D64s_v3" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_DS13-4_v2" | "Standard_DS13-2_v2" | "Standard_DS14-8_v2" | "Standard_DS14-4_v2" | "Standard_E2_v3" | "Standard_E4_v3" | "Standard_E8_v3" | "Standard_E16_v3" | "Standard_E32_v3" | "Standard_E64_v3" | "Standard_E2s_v3" | "Standard_E4s_v3" | "Standard_E8s_v3" | "Standard_E16s_v3" | "Standard_E32s_v3" | "Standard_E64s_v3" | "Standard_E32-16_v3" | "Standard_E32-8s_v3" | "Standard_E64-32s_v3" | "Standard_E64-16s_v3" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F1s" | "Standard_F2s" | "Standard_F4s" | "Standard_F8s" | "Standard_F16s" | "Standard_F2s_v2" | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" | "Standard_F32s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5" | "Standard_GS4-8" | "Standard_GS4-4" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H8" | "Standard_H16" | "Standard_H8m" | "Standard_H16m" | "Standard_H16r" | "Standard_H16mr" | "Standard_L4s" | "Standard_L8s" | "Standard_L16s" | "Standard_L32s" | "Standard_M64s" | "Standard_M64ms" | "Standard_M128s" | "Standard_M128ms" | "Standard_M64-32ms" | "Standard_M64-16ms" | "Standard_M128-64ms" | "Standard_M128-32ms" | "Standard_NC6" | "Standard_NC12" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC6s_v2" | "Standard_NC12s_v2" | "Standard_NC24s_v2" | "Standard_NC24rs_v2" | "Standard_NC6s_v3" | "Standard_NC12s_v3" | "Standard_NC24s_v3" | "Standard_NC24rs_v3" | "Standard_ND6s" | "Standard_ND12s" | "Standard_ND24s" | "Standard_ND24rs" | "Standard_NV6" | "Standard_NV12" | "Standard_NV24"

Defines values for VirtualMachineSizeTypes. Possible values include: 'Basic_A0', 'Basic_A1', 'Basic_A2', 'Basic_A3', 'Basic_A4', 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', 'Standard_A4', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A9', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', 'Standard_A2_v2', 'Standard_A4_v2', 'Standard_A8_v2', 'Standard_A2m_v2', 'Standard_A4m_v2', 'Standard_A8m_v2', 'Standard_B1s', 'Standard_B1ms', 'Standard_B2s', 'Standard_B2ms', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D2', 'Standard_D3', 'Standard_D4', 'Standard_D11', 'Standard_D12', 'Standard_D13', 'Standard_D14', 'Standard_D1_v2', 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', 'Standard_D2_v3', 'Standard_D4_v3', 'Standard_D8_v3', 'Standard_D16_v3', 'Standard_D32_v3', 'Standard_D64_v3', 'Standard_D2s_v3', 'Standard_D4s_v3', 'Standard_D8s_v3', 'Standard_D16s_v3', 'Standard_D32s_v3', 'Standard_D64s_v3', 'Standard_D11_v2', 'Standard_D12_v2', 'Standard_D13_v2', 'Standard_D14_v2', 'Standard_D15_v2', 'Standard_DS1', 'Standard_DS2', 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', 'Standard_DS13', 'Standard_DS14', 'Standard_DS1_v2', 'Standard_DS2_v2', 'Standard_DS3_v2', 'Standard_DS4_v2', 'Standard_DS5_v2', 'Standard_DS11_v2', 'Standard_DS12_v2', 'Standard_DS13_v2', 'Standard_DS14_v2', 'Standard_DS15_v2', 'Standard_DS13-4_v2', 'Standard_DS13-2_v2', 'Standard_DS14-8_v2', 'Standard_DS14-4_v2', 'Standard_E2_v3', 'Standard_E4_v3', 'Standard_E8_v3', 'Standard_E16_v3', 'Standard_E32_v3', 'Standard_E64_v3', 'Standard_E2s_v3', 'Standard_E4s_v3', 'Standard_E8s_v3', 'Standard_E16s_v3', 'Standard_E32s_v3', 'Standard_E64s_v3', 'Standard_E32-16_v3', 'Standard_E32-8s_v3', 'Standard_E64-32s_v3', 'Standard_E64-16s_v3', 'Standard_F1', 'Standard_F2', 'Standard_F4', 'Standard_F8', 'Standard_F16', 'Standard_F1s', 'Standard_F2s', 'Standard_F4s', 'Standard_F8s', 'Standard_F16s', 'Standard_F2s_v2', 'Standard_F4s_v2', 'Standard_F8s_v2', 'Standard_F16s_v2', 'Standard_F32s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_G1', 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS5', 'Standard_GS4-8', 'Standard_GS4-4', 'Standard_GS5-16', 'Standard_GS5-8', 'Standard_H8', 'Standard_H16', 'Standard_H8m', 'Standard_H16m', 'Standard_H16r', 'Standard_H16mr', 'Standard_L4s', 'Standard_L8s', 'Standard_L16s', 'Standard_L32s', 'Standard_M64s', 'Standard_M64ms', 'Standard_M128s', 'Standard_M128ms', 'Standard_M64-32ms', 'Standard_M64-16ms', 'Standard_M128-64ms', 'Standard_M128-32ms', 'Standard_NC6', 'Standard_NC12', 'Standard_NC24', 'Standard_NC24r', 'Standard_NC6s_v2', 'Standard_NC12s_v2', 'Standard_NC24s_v2', 'Standard_NC24rs_v2', 'Standard_NC6s_v3', 'Standard_NC12s_v3', 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', 'Standard_NV12', 'Standard_NV24'

readonly
enum

{string}

VirtualMachineSizesListResponse

VirtualMachineSizesListResponse: VirtualMachineSizeListResult & object

Contains response data for the list operation.

VirtualMachinesBeginCaptureResponse

VirtualMachinesBeginCaptureResponse: VirtualMachineCaptureResult & object

Contains response data for the beginCapture operation.

VirtualMachinesBeginConvertToManagedDisksResponse

VirtualMachinesBeginConvertToManagedDisksResponse: OperationStatusResponse & object

Contains response data for the beginConvertToManagedDisks operation.

VirtualMachinesBeginCreateOrUpdateResponse

VirtualMachinesBeginCreateOrUpdateResponse: VirtualMachine & object

Contains response data for the beginCreateOrUpdate operation.

VirtualMachinesBeginDeallocateResponse

VirtualMachinesBeginDeallocateResponse: OperationStatusResponse & object

Contains response data for the beginDeallocate operation.

VirtualMachinesBeginDeleteMethodResponse

VirtualMachinesBeginDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the beginDeleteMethod operation.

VirtualMachinesBeginPerformMaintenanceResponse

VirtualMachinesBeginPerformMaintenanceResponse: OperationStatusResponse & object

Contains response data for the beginPerformMaintenance operation.

VirtualMachinesBeginPowerOffResponse

VirtualMachinesBeginPowerOffResponse: OperationStatusResponse & object

Contains response data for the beginPowerOff operation.

VirtualMachinesBeginRedeployResponse

VirtualMachinesBeginRedeployResponse: OperationStatusResponse & object

Contains response data for the beginRedeploy operation.

VirtualMachinesBeginRestartResponse

VirtualMachinesBeginRestartResponse: OperationStatusResponse & object

Contains response data for the beginRestart operation.

VirtualMachinesBeginStartResponse

VirtualMachinesBeginStartResponse: OperationStatusResponse & object

Contains response data for the beginStart operation.

VirtualMachinesBeginUpdateResponse

VirtualMachinesBeginUpdateResponse: VirtualMachine & object

Contains response data for the beginUpdate operation.

VirtualMachinesCaptureResponse

VirtualMachinesCaptureResponse: VirtualMachineCaptureResult & object

Contains response data for the capture operation.

VirtualMachinesConvertToManagedDisksResponse

VirtualMachinesConvertToManagedDisksResponse: OperationStatusResponse & object

Contains response data for the convertToManagedDisks operation.

VirtualMachinesCreateOrUpdateResponse

VirtualMachinesCreateOrUpdateResponse: VirtualMachine & object

Contains response data for the createOrUpdate operation.

VirtualMachinesDeallocateResponse

VirtualMachinesDeallocateResponse: OperationStatusResponse & object

Contains response data for the deallocate operation.

VirtualMachinesDeleteMethodResponse

VirtualMachinesDeleteMethodResponse: OperationStatusResponse & object

Contains response data for the deleteMethod operation.

VirtualMachinesGeneralizeResponse

VirtualMachinesGeneralizeResponse: OperationStatusResponse & object

Contains response data for the generalize operation.

VirtualMachinesGetExtensionsResponse

VirtualMachinesGetExtensionsResponse: VirtualMachineExtensionsListResult & object

Contains response data for the getExtensions operation.

VirtualMachinesGetResponse

VirtualMachinesGetResponse: VirtualMachine & object

Contains response data for the get operation.

VirtualMachinesInstanceViewResponse

VirtualMachinesInstanceViewResponse: VirtualMachineInstanceView & object

Contains response data for the instanceView operation.

VirtualMachinesListAllNextResponse

VirtualMachinesListAllNextResponse: VirtualMachineListResult & object

Contains response data for the listAllNext operation.

VirtualMachinesListAllResponse

VirtualMachinesListAllResponse: VirtualMachineListResult & object

Contains response data for the listAll operation.

VirtualMachinesListAvailableSizesResponse

VirtualMachinesListAvailableSizesResponse: VirtualMachineSizeListResult & object

Contains response data for the listAvailableSizes operation.

VirtualMachinesListByLocationNextResponse

VirtualMachinesListByLocationNextResponse: VirtualMachineListResult & object

Contains response data for the listByLocationNext operation.

VirtualMachinesListByLocationResponse

VirtualMachinesListByLocationResponse: VirtualMachineListResult & object

Contains response data for the listByLocation operation.

VirtualMachinesListNextResponse

VirtualMachinesListNextResponse: VirtualMachineListResult & object

Contains response data for the listNext operation.

VirtualMachinesListResponse

VirtualMachinesListResponse: VirtualMachineListResult & object

Contains response data for the list operation.

VirtualMachinesPerformMaintenanceResponse

VirtualMachinesPerformMaintenanceResponse: OperationStatusResponse & object

Contains response data for the performMaintenance operation.

VirtualMachinesPowerOffResponse

VirtualMachinesPowerOffResponse: OperationStatusResponse & object

Contains response data for the powerOff operation.

VirtualMachinesRedeployResponse

VirtualMachinesRedeployResponse: OperationStatusResponse & object

Contains response data for the redeploy operation.

VirtualMachinesRestartResponse

VirtualMachinesRestartResponse: OperationStatusResponse & object

Contains response data for the restart operation.

VirtualMachinesStartResponse

VirtualMachinesStartResponse: OperationStatusResponse & object

Contains response data for the start operation.

VirtualMachinesUpdateResponse

VirtualMachinesUpdateResponse: VirtualMachine & object

Contains response data for the update operation.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AccessUri

AccessUri: object

A disk access SAS uri.

Optional accessSAS

accessSAS: undefined | string

A SAS uri for accessing a disk. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AccessUri"

type

type: object

className

className: string = "AccessUri"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessSAS

accessSAS: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.output.accessSAS"

type

type: object

name

name: "String" = "String"

Const AdditionalUnattendContent

AdditionalUnattendContent: object

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

Optional componentName

componentName: ComponentNames

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Possible values include: 'Microsoft-Windows-Shell-Setup'

Optional content

content: undefined | string

Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.

Optional passName

passName: PassNames

The pass name. Currently, the only allowable value is OobeSystem. Possible values include: 'OobeSystem'

Optional settingName

settingName: SettingNames

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Possible values include: 'AutoLogon', 'FirstLogonCommands'

serializedName

serializedName: string = "AdditionalUnattendContent"

type

type: object

className

className: string = "AdditionalUnattendContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

componentName

componentName: object

serializedName

serializedName: string = "componentName"

type

type: object

allowedValues

allowedValues: string[] = ["Microsoft-Windows-Shell-Setup"]

name

name: "Enum" = "Enum"

content

content: object

serializedName

serializedName: string = "content"

type

type: object

name

name: "String" = "String"

passName

passName: object

serializedName

serializedName: string = "passName"

type

type: object

allowedValues

allowedValues: string[] = ["OobeSystem"]

name

name: "Enum" = "Enum"

settingName

settingName: object

serializedName

serializedName: string = "settingName"

type

type: object

allowedValues

allowedValues: string[] = ["AutoLogon","FirstLogonCommands"]

name

name: "Enum" = "Enum"

Const ApiEntityReference

ApiEntityReference: object

The API entity reference.

Optional id

id: undefined | string

The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

serializedName

serializedName: string = "ApiEntityReference"

type

type: object

className

className: string = "ApiEntityReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const ApiError

ApiError: object

Api error.

Optional code

code: undefined | string

The error code.

Optional details

details: ApiErrorBase[]

The Api error details

Optional innererror

innererror: InnerError

The Api inner error

Optional message

message: undefined | string

The error message.

Optional target

target: undefined | string

The target of the particular error.

serializedName

serializedName: string = "ApiError"

type

type: object

className

className: string = "ApiError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApiErrorBase"

name

name: "Composite" = "Composite"

innererror

innererror: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "InnerError"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const ApiErrorBase

ApiErrorBase: object

Api error base.

Optional code

code: undefined | string

The error code.

Optional message

message: undefined | string

The error message.

Optional target

target: undefined | string

The target of the particular error.

serializedName

serializedName: string = "ApiErrorBase"

type

type: object

className

className: string = "ApiErrorBase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const AutoOSUpgradePolicy

AutoOSUpgradePolicy: object

The configuration parameters used for performing automatic OS upgrade.

Optional disableAutoRollback

disableAutoRollback: undefined | false | true

Whether OS image rollback feature should be disabled. Default value is false.

serializedName

serializedName: string = "AutoOSUpgradePolicy"

type

type: object

className

className: string = "AutoOSUpgradePolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disableAutoRollback

disableAutoRollback: object

serializedName

serializedName: string = "disableAutoRollback"

type

type: object

name

name: "Boolean" = "Boolean"

Const AvailabilitySet

AvailabilitySet: object

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines.

For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

Optional id

id: undefined | string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

Optional platformFaultDomainCount

platformFaultDomainCount: undefined | number

Fault Domain count.

Optional platformUpdateDomainCount

platformUpdateDomainCount: undefined | number

Update Domain count.

Optional sku

sku: Sku

Sku of the availability set

Optional statuses

statuses: InstanceViewStatus[]

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags

Optional virtualMachines

virtualMachines: SubResource[]

A list of references to all virtual machines in the availability set.

serializedName

serializedName: string = "AvailabilitySet"

Optional type

type: object

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AvailabilitySet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

platformFaultDomainCount

platformFaultDomainCount: object

serializedName

serializedName: string = "properties.platformFaultDomainCount"

type

type: object

name

name: "Number" = "Number"

platformUpdateDomainCount

platformUpdateDomainCount: object

serializedName

serializedName: string = "properties.platformUpdateDomainCount"

type

type: object

name

name: "Number" = "Number"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

statuses

statuses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.statuses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InstanceViewStatus"

name

name: "Composite" = "Composite"

virtualMachines

virtualMachines: object

serializedName

serializedName: string = "properties.virtualMachines"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const AvailabilitySetListResult

AvailabilitySetListResult: object
interface

The List Availability Set operation response.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.

serializedName

serializedName: string = "AvailabilitySetListResult"

__@iterator

  • Iterator

    Returns IterableIterator<AvailabilitySet>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AvailabilitySet>[]

      Additional items to add to the end of array1.

    Returns AvailabilitySet[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AvailabilitySet[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AvailabilitySet]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AvailabilitySet, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AvailabilitySet

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AvailabilitySet[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AvailabilitySet[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AvailabilitySet | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns AvailabilitySet | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AvailabilitySet, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AvailabilitySet

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AvailabilitySet, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AvailabilitySet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AvailabilitySet, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AvailabilitySet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns AvailabilitySet | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AvailabilitySet

  • Parameters

    Returns AvailabilitySet

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AvailabilitySet

  • Parameters

    Returns AvailabilitySet

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns AvailabilitySet[]

shift

  • Removes the first element from an array and returns it.

    Returns AvailabilitySet | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AvailabilitySet[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AvailabilitySet[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AvailabilitySet[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AvailabilitySet[]

      Elements to insert into the array in place of the deleted elements.

    Returns AvailabilitySet[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AvailabilitySet[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<AvailabilitySet>

type

type: object

className

className: string = "AvailabilitySetListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AvailabilitySet"

name

name: "Composite" = "Composite"

Const AvailabilitySetUpdate

AvailabilitySetUpdate: object

Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated.

Optional platformFaultDomainCount

platformFaultDomainCount: undefined | number

Fault Domain count.

Optional platformUpdateDomainCount

platformUpdateDomainCount: undefined | number

Update Domain count.

Optional sku

sku: Sku

Sku of the availability set

Optional statuses

statuses: InstanceViewStatus[]

The resource status information. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags

Optional virtualMachines

virtualMachines: SubResource[]

A list of references to all virtual machines in the availability set.

serializedName

serializedName: string = "AvailabilitySetUpdate"

type

type: object

className

className: string = "AvailabilitySetUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

platformFaultDomainCount

platformFaultDomainCount: object

serializedName

serializedName: string = "properties.platformFaultDomainCount"

type

type: object

name

name: "Number" = "Number"

platformUpdateDomainCount

platformUpdateDomainCount: object

serializedName

serializedName: string = "properties.platformUpdateDomainCount"

type

type: object

name

name: "Number" = "Number"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

statuses

statuses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.statuses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InstanceViewStatus"

name

name: "Composite" = "Composite"

virtualMachines

virtualMachines: object

serializedName

serializedName: string = "properties.virtualMachines"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const BootDiagnostics

BootDiagnostics: object

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.

Optional enabled

enabled: undefined | false | true

Whether boot diagnostics should be enabled on the Virtual Machine.

Optional storageUri

storageUri: undefined | string

Uri of the storage account to use for placing the console output and screenshot.

serializedName

serializedName: string = "BootDiagnostics"

type

type: object

className

className: string = "BootDiagnostics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

storageUri

storageUri: object

serializedName

serializedName: string = "storageUri"

type

type: object

name

name: "String" = "String"

Const BootDiagnosticsInstanceView

BootDiagnosticsInstanceView: object

The instance view of a virtual machine boot diagnostics.

Optional consoleScreenshotBlobUri

consoleScreenshotBlobUri: undefined | string

The console screenshot blob URI. NOTE: This property will not be serialized. It can only be populated by the server.

Optional serialConsoleLogBlobUri

serialConsoleLogBlobUri: undefined | string

The Linux serial console log blob Uri. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BootDiagnosticsInstanceView"

type

type: object

className

className: string = "BootDiagnosticsInstanceView"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

consoleScreenshotBlobUri

consoleScreenshotBlobUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "consoleScreenshotBlobUri"

type

type: object

name

name: "String" = "String"

serialConsoleLogBlobUri

serialConsoleLogBlobUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "serialConsoleLogBlobUri"

type

type: object

name

name: "String" = "String"

Const ComputeLongRunningOperationProperties

ComputeLongRunningOperationProperties: object

Compute-specific operation properties, including output

Optional output

output: any

Operation output data (raw JSON)

serializedName

serializedName: string = "ComputeLongRunningOperationProperties"

type

type: object

className

className: string = "ComputeLongRunningOperationProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

output

output: object

serializedName

serializedName: string = "output"

type

type: object

name

name: "Object" = "Object"

Const ComputeOperationListResult

ComputeOperationListResult: object
interface

The List Compute Operation operation response.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ComputeOperationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ComputeOperationValue>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ComputeOperationValue[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ComputeOperationValue[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ComputeOperationValue]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ComputeOperationValue

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ComputeOperationValue[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ComputeOperationValue[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ComputeOperationValue | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ComputeOperationValue | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ComputeOperationValue

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ComputeOperationValue

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ComputeOperationValue

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ComputeOperationValue | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ComputeOperationValue

  • Parameters

    Returns ComputeOperationValue

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ComputeOperationValue[]

shift

  • Removes the first element from an array and returns it.

    Returns ComputeOperationValue | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ComputeOperationValue[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ComputeOperationValue[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ComputeOperationValue[]

      Elements to insert into the array in place of the deleted elements.

    Returns ComputeOperationValue[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ComputeOperationValue>

type

type: object

className

className: string = "ComputeOperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeOperationValue"

name

name: "Composite" = "Composite"

Const ComputeOperationValue

ComputeOperationValue: object

Describes the properties of a Compute Operation value.

Optional description

description: undefined | string

The description of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the compute operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operation

operation: undefined | string

The display name of the compute operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional origin

origin: undefined | string

The origin of the compute operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provider

provider: undefined | string

The resource provider for the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resource

resource: undefined | string

The display name of the resource the operation applies to. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ComputeOperationValue"

type

type: object

className

className: string = "ComputeOperationValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "display.description"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

operation

operation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "display.operation"

type

type: object

name

name: "String" = "String"

origin

origin: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

provider

provider: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "display.provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "display.resource"

type

type: object

name

name: "String" = "String"

Const CreationData

CreationData: object

Data used when creating a disk.

createOption

createOption: DiskCreateOption

This enumerates the possible sources of a disk's creation. Possible values include: 'Empty', 'Attach', 'FromImage', 'Import', 'Copy'

Optional imageReference

imageReference: ImageDiskReference

Disk source information.

Optional sourceResourceId

sourceResourceId: undefined | string

If createOption is Copy, this is the ARM id of the source snapshot or disk.

Optional sourceUri

sourceUri: undefined | string

If createOption is Import, this is the URI of a blob to be imported into a managed disk.

Optional storageAccountId

storageAccountId: undefined | string

If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription

serializedName

serializedName: string = "CreationData"

type

type: object

className

className: string = "CreationData"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createOption

createOption: object

required

required: true = true

serializedName

serializedName: string = "createOption"

type

type: object

allowedValues

allowedValues: string[] = ["Empty","Attach","FromImage","Import","Copy"]

name

name: "Enum" = "Enum"

imageReference

imageReference: object

serializedName

serializedName: string = "imageReference"

type

type: object

className

className: string = "ImageDiskReference"

name

name: "Composite" = "Composite"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

sourceUri

sourceUri: object

serializedName

serializedName: string = "sourceUri"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

serializedName

serializedName: string = "storageAccountId"

type

type: object

name

name: "String" = "String"

Const DataDisk

DataDisk: object

Describes a data disk.

Optional caching

caching: CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

createOption

createOption: DiskCreateOptionTypes

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach'

Optional diskSizeGB

diskSizeGB: undefined | number

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

Optional image

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

lun

lun: number

Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

Optional managedDisk

The managed disk parameters.

Optional name

name: undefined | string

The disk name.

Optional vhd

The virtual hard disk.

Optional writeAcceleratorEnabled

writeAcceleratorEnabled: undefined | false | true

Specifies whether writeAccelerator should be enabled or disabled on the disk.

serializedName

serializedName: string = "DataDisk"

type

type: object

className

className: string = "DataDisk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

caching

caching: object

serializedName

serializedName: string = "caching"

type

type: object

allowedValues

allowedValues: string[] = ["None","ReadOnly","ReadWrite"]

name

name: "Enum" = "Enum"

createOption

createOption: object

required

required: true = true

serializedName

serializedName: string = "createOption"

type

type: object

name

name: "String" = "String"

diskSizeGB

diskSizeGB: object

serializedName

serializedName: string = "diskSizeGB"

type

type: object

name

name: "Number" = "Number"

image

image: object

serializedName

serializedName: string = "image"

type

type: object

className

className: string = "VirtualHardDisk"

name

name: "Composite" = "Composite"

lun

lun: object

required

required: true = true

serializedName

serializedName: string = "lun"

type

type: object

name

name: "Number" = "Number"

managedDisk

managedDisk: object

serializedName

serializedName: string = "managedDisk"

type

type: object

className

className: string = "ManagedDiskParameters"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

vhd

vhd: object

serializedName

serializedName: string = "vhd"

type

type: object

className

className: string = "VirtualHardDisk"

name

name: "Composite" = "Composite"

writeAcceleratorEnabled

writeAcceleratorEnabled: object

serializedName

serializedName: string = "writeAcceleratorEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const DataDiskImage

DataDiskImage: object

Contains the data disk images information.

Optional lun

lun: undefined | number

Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DataDiskImage"

type

type: object

className

className: string = "DataDiskImage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lun

lun: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lun"

type

type: object

name

name: "Number" = "Number"

Const DiagnosticsProfile

DiagnosticsProfile: object

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

Optional bootDiagnostics

bootDiagnostics: BootDiagnostics

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.

serializedName

serializedName: string = "DiagnosticsProfile"

type

type: object

className

className: string = "DiagnosticsProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bootDiagnostics

bootDiagnostics: object

serializedName

serializedName: string = "bootDiagnostics"

type

type: object

className

className: string = "BootDiagnostics"

name

name: "Composite" = "Composite"

Const Disk

Disk: object

Disk resource.

creationData

creationData: CreationData

Disk source information. CreationData information cannot be changed after the disk has been created.

Optional diskSizeGB

diskSizeGB: undefined | number

If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

Optional encryptionSettings

encryptionSettings: EncryptionSettings

Encryption settings for disk or snapshot

Optional id

id: undefined | string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional managedBy

managedBy: undefined | string

A relative URI containing the ID of the VM that has the disk attached. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

Optional osType

The Operating System type. Possible values include: 'Windows', 'Linux'

Optional provisioningState

provisioningState: undefined | string

The disk provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sku

sku: DiskSku

Optional tags

tags: undefined | object

Resource tags

Optional timeCreated

timeCreated: Date

The time when the disk was created. NOTE: This property will not be serialized. It can only be populated by the server.

Optional zones

zones: string[]

The Logical zone list for Disk.

serializedName

serializedName: string = "Disk"

Optional type

type: object

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Disk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationData

creationData: object

required

required: true = true

serializedName

serializedName: string = "properties.creationData"

type

type: object

className

className: string = "CreationData"

name

name: "Composite" = "Composite"

diskSizeGB

diskSizeGB: object

serializedName

serializedName: string = "properties.diskSizeGB"

type

type: object

name

name: "Number" = "Number"

encryptionSettings

encryptionSettings: object

serializedName

serializedName: string = "properties.encryptionSettings"

type

type: object

className

className: string = "EncryptionSettings"

name

name: "Composite" = "Composite"

managedBy

managedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "managedBy"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

allowedValues

allowedValues: string[] = ["Windows","Linux"]

name

name: "Enum" = "Enum"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "DiskSku"

name

name: "Composite" = "Composite"

timeCreated

timeCreated: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.timeCreated"

type

type: object

name

name: "DateTime" = "DateTime"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const DiskEncryptionSettings

DiskEncryptionSettings: object

Describes a Encryption Settings for a Disk

Optional diskEncryptionKey

diskEncryptionKey: KeyVaultSecretReference

Specifies the location of the disk encryption key, which is a Key Vault Secret.

Optional enabled

enabled: undefined | false | true

Specifies whether disk encryption should be enabled on the virtual machine.

Optional keyEncryptionKey

keyEncryptionKey: KeyVaultKeyReference

Specifies the location of the key encryption key in Key Vault.

serializedName

serializedName: string = "DiskEncryptionSettings"

type

type: object

className

className: string = "DiskEncryptionSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskEncryptionKey

diskEncryptionKey: object

serializedName

serializedName: string = "diskEncryptionKey"

type

type: object

className

className: string = "KeyVaultSecretReference"

name

name: "Composite" = "Composite"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

keyEncryptionKey

keyEncryptionKey: object

serializedName

serializedName: string = "keyEncryptionKey"

type

type: object

className

className: string = "KeyVaultKeyReference"

name

name: "Composite" = "Composite"

Const DiskInstanceView

DiskInstanceView: object

The instance view of the disk.

Optional encryptionSettings

encryptionSettings: DiskEncryptionSettings[]

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

Optional name

name: undefined | string

The disk name.

Optional statuses

statuses: InstanceViewStatus[]

The resource status information.

serializedName

serializedName: string = "DiskInstanceView"

type

type: object

className

className: string = "DiskInstanceView"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encryptionSettings

encryptionSettings: object

serializedName

serializedName: string = "encryptionSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiskEncryptionSettings"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

statuses

statuses: object

serializedName

serializedName: string = "statuses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InstanceViewStatus"

name

name: "Composite" = "Composite"

Const DiskList

DiskList: object
interface

The List Disks operation response.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks.

serializedName

serializedName: string = "DiskList"

__@iterator

  • __@iterator(): IterableIterator<Disk>
  • Iterator

    Returns IterableIterator<Disk>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Disk>[]): Disk[]
  • concat(...items: (T | ConcatArray<T>)[]): Disk[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Disk>[]

      Additional items to add to the end of array1.

    Returns Disk[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Disk[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Disk]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Disk]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Disk, index: number, array: Disk[]): boolean
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Disk, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Disk

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Disk[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): boolean
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): any
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Disk[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Disk | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Disk, index: number, obj: Disk[]): boolean
        • Parameters

          • this: void
          • value: Disk
          • index: number
          • obj: Disk[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Disk, index: number, obj: Disk[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Disk | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Disk, index: number, obj: Disk[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): void
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Disk, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Disk

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Disk, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Disk

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Disk, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Disk

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Disk, index: number, array: Disk[]): U
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Disk | undefined
  • Removes the last element from an array and returns it.

    Returns Disk | undefined

push

  • push(...items: Disk[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Disk[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Disk
  • reduce(callbackfn: function, initialValue: Disk): Disk
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    Returns Disk

  • Parameters

    • callbackfn: function
        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    • initialValue: Disk

    Returns Disk

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Disk, currentIndex: number, array: Disk[]): U
        • Parameters

          • previousValue: U
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Disk
  • reduceRight(callbackfn: function, initialValue: Disk): Disk
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    Returns Disk

  • Parameters

    • callbackfn: function
        • (previousValue: Disk, currentValue: Disk, currentIndex: number, array: Disk[]): Disk
        • Parameters

          • previousValue: Disk
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns Disk

    • initialValue: Disk

    Returns Disk

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Disk, currentIndex: number, array: Disk[]): U
        • Parameters

          • previousValue: U
          • currentValue: Disk
          • currentIndex: number
          • array: Disk[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Disk[]

shift

  • shift(): Disk | undefined
  • Removes the first element from an array and returns it.

    Returns Disk | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Disk[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Disk[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Disk, index: number, array: Disk[]): boolean
        • Parameters

          • value: Disk
          • index: number
          • array: Disk[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Disk[]
  • splice(start: number, deleteCount: number, ...items: Disk[]): Disk[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Disk[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Disk[]

      Elements to insert into the array in place of the deleted elements.

    Returns Disk[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Disk[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Disk[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Disk>
  • Returns an iterable of values in the array

    Returns IterableIterator<Disk>

type

type: object

className

className: string = "DiskList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Disk"

name

name: "Composite" = "Composite"

Const DiskSku

DiskSku: object

The disks and snapshots sku name. Can be Standard_LRS or Premium_LRS.

Optional name

The sku name. Possible values include: 'Standard_LRS', 'Premium_LRS'

Optional tier

tier: undefined | string

The sku tier. NOTE: This property will not be serialized. It can only be populated by the server.. Default value: 'Standard'.

serializedName

serializedName: string = "DiskSku"

type

type: object

className

className: string = "DiskSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tier

tier: object

defaultValue

defaultValue: string = "Standard"

readOnly

readOnly: true = true

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const DiskUpdate

DiskUpdate: object

Disk update resource.

Optional diskSizeGB

diskSizeGB: undefined | number

If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

Optional encryptionSettings

encryptionSettings: EncryptionSettings

Encryption settings for disk or snapshot

Optional osType

the Operating System type. Possible values include: 'Windows', 'Linux'

Optional sku

sku: DiskSku

Optional tags

tags: undefined | object

Resource tags

serializedName

serializedName: string = "DiskUpdate"

type

type: object

className

className: string = "DiskUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskSizeGB

diskSizeGB: object

serializedName

serializedName: string = "properties.diskSizeGB"

type

type: object

name

name: "Number" = "Number"

encryptionSettings

encryptionSettings: object

serializedName

serializedName: string = "properties.encryptionSettings"

type

type: object

className

className: string = "EncryptionSettings"

name

name: "Composite" = "Composite"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

allowedValues

allowedValues: string[] = ["Windows","Linux"]

name

name: "Enum" = "Enum"

Const EncryptionSettings

EncryptionSettings: object

Encryption settings for disk or snapshot

Optional diskEncryptionKey

diskEncryptionKey: KeyVaultAndSecretReference

Key Vault Secret Url and vault id of the disk encryption key

Optional enabled

enabled: undefined | false | true

Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.

Optional keyEncryptionKey

keyEncryptionKey: KeyVaultAndKeyReference

Key Vault Key Url and vault id of the key encryption key

serializedName

serializedName: string = "EncryptionSettings"

type

type: object

className

className: string = "EncryptionSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskEncryptionKey

diskEncryptionKey: object

serializedName

serializedName: string = "diskEncryptionKey"

type

type: object

className

className: string = "KeyVaultAndSecretReference"

name

name: "Composite" = "Composite"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

keyEncryptionKey

keyEncryptionKey: object

serializedName

serializedName: string = "keyEncryptionKey"

type

type: object

className

className: string = "KeyVaultAndKeyReference"

name

name: "Composite" = "Composite"

Const GrantAccessData

GrantAccessData: object

Data used for requesting a SAS.

access

access: AccessLevel

Possible values include: 'None', 'Read'

durationInSeconds

durationInSeconds: number

Time duration in seconds until the SAS access expires.

serializedName

serializedName: string = "GrantAccessData"

type

type: object

className

className: string = "GrantAccessData"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

required

required: true = true

serializedName

serializedName: string = "access"

type

type: object

allowedValues

allowedValues: string[] = ["None","Read"]

name

name: "Enum" = "Enum"

durationInSeconds

durationInSeconds: object

required

required: true = true

serializedName

serializedName: string = "durationInSeconds"

type

type: object

name

name: "Number" = "Number"

Const HardwareProfile

HardwareProfile: object

Specifies the hardware settings for the virtual machine.

Optional vmSize

Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

List all available virtual machine sizes for resizing. Possible values include: 'Basic_A0', 'Basic_A1', 'Basic_A2', 'Basic_A3', 'Basic_A4', 'Standard_A0', 'Standard_A1', 'Standard_A2', 'Standard_A3', 'Standard_A4', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A9', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', 'Standard_A2_v2', 'Standard_A4_v2', 'Standard_A8_v2', 'Standard_A2m_v2', 'Standard_A4m_v2', 'Standard_A8m_v2', 'Standard_B1s', 'Standard_B1ms', 'Standard_B2s', 'Standard_B2ms', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D2', 'Standard_D3', 'Standard_D4', 'Standard_D11', 'Standard_D12', 'Standard_D13', 'Standard_D14', 'Standard_D1_v2', 'Standard_D2_v2', 'Standard_D3_v2', 'Standard_D4_v2', 'Standard_D5_v2', 'Standard_D2_v3', 'Standard_D4_v3', 'Standard_D8_v3', 'Standard_D16_v3', 'Standard_D32_v3', 'Standard_D64_v3', 'Standard_D2s_v3', 'Standard_D4s_v3', 'Standard_D8s_v3', 'Standard_D16s_v3', 'Standard_D32s_v3', 'Standard_D64s_v3', 'Standard_D11_v2', 'Standard_D12_v2', 'Standard_D13_v2', 'Standard_D14_v2', 'Standard_D15_v2', 'Standard_DS1', 'Standard_DS2', 'Standard_DS3', 'Standard_DS4', 'Standard_DS11', 'Standard_DS12', 'Standard_DS13', 'Standard_DS14', 'Standard_DS1_v2', 'Standard_DS2_v2', 'Standard_DS3_v2', 'Standard_DS4_v2', 'Standard_DS5_v2', 'Standard_DS11_v2', 'Standard_DS12_v2', 'Standard_DS13_v2', 'Standard_DS14_v2', 'Standard_DS15_v2', 'Standard_DS13-4_v2', 'Standard_DS13-2_v2', 'Standard_DS14-8_v2', 'Standard_DS14-4_v2', 'Standard_E2_v3', 'Standard_E4_v3', 'Standard_E8_v3', 'Standard_E16_v3', 'Standard_E32_v3', 'Standard_E64_v3', 'Standard_E2s_v3', 'Standard_E4s_v3', 'Standard_E8s_v3', 'Standard_E16s_v3', 'Standard_E32s_v3', 'Standard_E64s_v3', 'Standard_E32-16_v3', 'Standard_E32-8s_v3', 'Standard_E64-32s_v3', 'Standard_E64-16s_v3', 'Standard_F1', 'Standard_F2', 'Standard_F4', 'Standard_F8', 'Standard_F16', 'Standard_F1s', 'Standard_F2s', 'Standard_F4s', 'Standard_F8s', 'Standard_F16s', 'Standard_F2s_v2', 'Standard_F4s_v2', 'Standard_F8s_v2', 'Standard_F16s_v2', 'Standard_F32s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_G1', 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS5', 'Standard_GS4-8', 'Standard_GS4-4', 'Standard_GS5-16', 'Standard_GS5-8', 'Standard_H8', 'Standard_H16', 'Standard_H8m', 'Standard_H16m', 'Standard_H16r', 'Standard_H16mr', 'Standard_L4s', 'Standard_L8s', 'Standard_L16s', 'Standard_L32s', 'Standard_M64s', 'Standard_M64ms', 'Standard_M128s', 'Standard_M128ms', 'Standard_M64-32ms', 'Standard_M64-16ms', 'Standard_M128-64ms', 'Standard_M128-32ms', 'Standard_NC6', 'Standard_NC12', 'Standard_NC24', 'Standard_NC24r', 'Standard_NC6s_v2', 'Standard_NC12s_v2', 'Standard_NC24s_v2', 'Standard_NC24rs_v2', 'Standard_NC6s_v3', 'Standard_NC12s_v3', 'Standard_NC24s_v3', 'Standard_NC24rs_v3', 'Standard_ND6s', 'Standard_ND12s', 'Standard_ND24s', 'Standard_ND24rs', 'Standard_NV6', 'Standard_NV12', 'Standard_NV24'

serializedName

serializedName: string = "HardwareProfile"

type

type: object

className

className: string = "HardwareProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

vmSize

vmSize: object

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const Image

Image: object

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Optional id

id: undefined | string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional name

name: undefined | string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sourceVirtualMachine

sourceVirtualMachine: SubResource

The source virtual machine from which Image is created.

Optional storageProfile

storageProfile: ImageStorageProfile

Specifies the storage settings for the virtual machine disks.

Optional tags

tags: undefined | object

Resource tags

serializedName

serializedName: string = "Image"

Optional type

type: object

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Image"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sourceVirtualMachine

sourceVirtualMachine: object

serializedName

serializedName: string = "properties.sourceVirtualMachine"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

storageProfile

storageProfile: object

serializedName

serializedName: string = "properties.storageProfile"

type

type: object

className

className: string = "ImageStorageProfile"

name

name: "Composite" = "Composite"

Const ImageDataDisk

ImageDataDisk: object

Describes a data disk.

Optional blobUri

blobUri: undefined | string

The Virtual Hard Disk.

Optional caching

caching: CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

Optional diskSizeGB

diskSizeGB: undefined | number

Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

lun

lun: number

Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

Optional managedDisk

managedDisk: SubResource

The managedDisk.

Optional snapshot

snapshot: SubResource

The snapshot.

Optional storageAccountType

storageAccountType: StorageAccountTypes

Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

serializedName

serializedName: string = "ImageDataDisk"

type

type: object

className

className: string = "ImageDataDisk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobUri

blobUri: object

serializedName

serializedName: string = "blobUri"

type

type: object

name

name: "String" = "String"

caching

caching: object

serializedName

serializedName: string = "caching"

type

type: object

allowedValues

allowedValues: string[] = ["None","ReadOnly","ReadWrite"]

name

name: "Enum" = "Enum"

diskSizeGB

diskSizeGB: object

serializedName

serializedName: string = "diskSizeGB"

type

type: object

name

name: "Number" = "Number"

lun

lun: object

required

required: true = true

serializedName

serializedName: string = "lun"

type

type: object

name

name: "Number" = "Number"

managedDisk

managedDisk: object

serializedName

serializedName: string = "managedDisk"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

snapshot

snapshot: object

serializedName

serializedName: string = "snapshot"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

storageAccountType

storageAccountType: object

serializedName

serializedName: string = "storageAccountType"

type

type: object

name

name: "String" = "String"

Const ImageDiskReference

ImageDiskReference: object

The source image used for creating the disk.

id

id: string

A relative uri containing either a Platform Image Repository or user image reference.

Optional lun

lun: undefined | number

If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.

serializedName

serializedName: string = "ImageDiskReference"

type

type: object

className

className: string = "ImageDiskReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lun

lun: object

serializedName

serializedName: string = "lun"

type

type: object

name

name: "Number" = "Number"

Const ImageListResult

ImageListResult: object
interface

The List Image operation response.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images.

serializedName

serializedName: string = "ImageListResult"

__@iterator

  • __@iterator(): IterableIterator<Image>
  • Iterator

    Returns IterableIterator<Image>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Image>[]): Image[]
  • concat(...items: (T | ConcatArray<T>)[]): Image[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Image>[]

      Additional items to add to the end of array1.

    Returns Image[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Image[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Image]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Image]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Image, index: number, array: Image[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Image, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Image

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Image[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Image, index: number, array: Image[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Image, index: number, array: Image[]): any
        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Image[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Image | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Image, index: number, obj: Image[]): boolean
        • Parameters

          • this: void
          • value: Image
          • index: number
          • obj: Image[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Image, index: number, obj: Image[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Image | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Image, index: number, obj: Image[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Image, index: number, array: Image[]): void
        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Image, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Image

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Image, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Image

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Image, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Image

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Image, index: number, array: Image[]): U
        • Parameters

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Image | undefined
  • Removes the last element from an array and returns it.

    Returns Image | undefined

push

  • push(...items: Image[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Image[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Image
  • reduce(callbackfn: function, initialValue: Image): Image
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Image

  • Parameters

    • callbackfn: function
    • initialValue: Image

    Returns Image

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Image, currentIndex: number, array: Image[]): U
        • Parameters

          • previousValue: U
          • currentValue: Image
          • currentIndex: number
          • array: Image[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Image
  • reduceRight(callbackfn: function, initialValue: Image): Image
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Image

  • Parameters

    • callbackfn: function
    • initialValue: Image

    Returns Image

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Image, currentIndex: number, array: Image[]): U
        • Parameters

          • previousValue: U
          • currentValue: Image
          • currentIndex: number
          • array: Image[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Image[]

shift

  • shift(): Image | undefined
  • Removes the first element from an array and returns it.

    Returns Image | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Image[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Image[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Image, index: number, array: Image[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Image[]
  • splice(start: number, deleteCount: number, ...items: Image[]): Image[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Image[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Image[]

      Elements to insert into the array in place of the deleted elements.

    Returns Image[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Image[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Image[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Image>
  • Returns an iterable of values in the array

    Returns IterableIterator<Image>

type

type: object

className

className: string = "ImageListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Image"

name

name: "Composite" = "Composite"

Const ImageOSDisk

ImageOSDisk: object

Describes an Operating System disk.

Optional blobUri

blobUri: undefined | string

The Virtual Hard Disk.

Optional caching

caching: CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

Optional diskSizeGB

diskSizeGB: undefined | number

Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

Optional managedDisk

managedDisk: SubResource

The managedDisk.

osState

The OS State. Possible values include: 'Generalized', 'Specialized'

osType

This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

Possible values are:

Windows

Linux. Possible values include: 'Windows', 'Linux'

Optional snapshot

snapshot: SubResource

The snapshot.

Optional storageAccountType

storageAccountType: StorageAccountTypes

Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

serializedName

serializedName: string = "ImageOSDisk"

type

type: object

className

className: string = "ImageOSDisk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobUri

blobUri: object

serializedName

serializedName: string = "blobUri"

type

type: object

name

name: "String" = "String"

caching

caching: object

serializedName

serializedName: string = "caching"

type

type: object

allowedValues

allowedValues: string[] = ["None","ReadOnly","ReadWrite"]

name

name: "Enum" = "Enum"

diskSizeGB

diskSizeGB: object

serializedName

serializedName: string = "diskSizeGB"

type

type: object

name

name: "Number" = "Number"

managedDisk

managedDisk: object

serializedName

serializedName: string = "managedDisk"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

osState

osState: object

required

required: true = true

serializedName

serializedName: string = "osState"

type

type: object

allowedValues

allowedValues: string[] = ["Generalized","Specialized"]

name

name: "Enum" = "Enum"

osType

osType: object

required

required: true = true

serializedName

serializedName: string = "osType"

type

type: object

allowedValues

allowedValues: string[] = ["Windows","Linux"]

name

name: "Enum" = "Enum"

snapshot

snapshot: object

serializedName

serializedName: string = "snapshot"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

storageAccountType

storageAccountType: object

serializedName

serializedName: string = "storageAccountType"

type

type: object

name

name: "String" = "String"

Const ImageReference

ImageReference: object

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.

Optional id

id: undefined | string

Resource Id

Optional offer

offer: undefined | string

Specifies the offer of the platform image or marketplace image used to create the virtual machine.

Optional publisher

publisher: undefined | string

The image publisher.

Optional sku

sku: undefined | string

The image SKU.

Optional version

version: undefined | string

Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available.

serializedName

serializedName: string = "ImageReference"

type

type: object

className

className: string = "ImageReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

offer

offer: object

serializedName

serializedName: string = "offer"

type

type: object

name

name: "String" = "String"

publisher

publisher: object

serializedName

serializedName: string = "publisher"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const ImageStorageProfile

ImageStorageProfile: object

Describes a storage profile.

Optional dataDisks

dataDisks: ImageDataDisk[]

Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Optional osDisk

osDisk: ImageOSDisk

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Optional zoneResilient

zoneResilient: undefined | false | true

Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

serializedName

serializedName: string = "ImageStorageProfile"

type

type: object

className

className: string = "ImageStorageProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataDisks

dataDisks: object

serializedName

serializedName: string = "dataDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ImageDataDisk"

name

name: "Composite" = "Composite"

osDisk

osDisk: object

serializedName

serializedName: string = "osDisk"

type

type: object

className

className: string = "ImageOSDisk"

name

name: "Composite" = "Composite"

zoneResilient

zoneResilient: object

serializedName

serializedName: string = "zoneResilient"

type

type: object

name

name: "Boolean" = "Boolean"

Const ImageUpdate

ImageUpdate: object

The source user image virtual hard disk. Only tags may be updated.

Optional provisioningState

provisioningState: undefined | string

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sourceVirtualMachine

sourceVirtualMachine: SubResource

The source virtual machine from which Image is created.

Optional storageProfile

storageProfile: ImageStorageProfile

Specifies the storage settings for the virtual machine disks.

Optional tags

tags: undefined | object

Resource tags

serializedName

serializedName: string = "ImageUpdate"

type

type: object

className

className: string = "ImageUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sourceVirtualMachine

sourceVirtualMachine: object

serializedName

serializedName: string = "properties.sourceVirtualMachine"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

storageProfile

storageProfile: object

serializedName

serializedName: string = "properties.storageProfile"

type

type: object

className

className: string = "ImageStorageProfile"

name

name: "Composite" = "Composite"

Const InnerError

InnerError: object

Inner error details.

Optional errordetail

errordetail: undefined | string

The internal error message or exception dump.

Optional exceptiontype

exceptiontype: undefined | string

The exception type.

serializedName

serializedName: string = "InnerError"

type

type: object

className

className: string = "InnerError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errordetail

errordetail: object

serializedName

serializedName: string = "errordetail"

type

type: object

name

name: "String" = "String"

exceptiontype

exceptiontype: object

serializedName

serializedName: string = "exceptiontype"

type

type: object

name

name: "String" = "String"

Const InstanceViewStatus

InstanceViewStatus: object

Instance view status.

Optional code

code: undefined | string

The status code.

Optional displayStatus

displayStatus: undefined | string

The short localizable label for the status.

Optional level

The level code. Possible values include: 'Info', 'Warning', 'Error'

Optional message

message: undefined | string

The detailed status message, including for alerts and error messages.

Optional time

time: Date

The time of the status.

serializedName

serializedName: string = "InstanceViewStatus"

type

type: object

className

className: string = "InstanceViewStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

displayStatus

displayStatus: object

serializedName

serializedName: string = "displayStatus"

type

type: object

name

name: "String" = "String"

level

level: object

serializedName

serializedName: string = "level"

type

type: object

allowedValues

allowedValues: string[] = ["Info","Warning","Error"]

name

name: "Enum" = "Enum"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

time

time: object

serializedName

serializedName: string = "time"

type

type: object

name

name: "DateTime" = "DateTime"

Const KeyVaultAndKeyReference

KeyVaultAndKeyReference: object

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey

keyUrl

keyUrl: string

Url pointing to a key or secret in KeyVault

sourceVault

sourceVault: SourceVault

Resource id of the KeyVault containing the key or secret

serializedName

serializedName: string = "KeyVaultAndKeyReference"

type

type: object

className

className: string = "KeyVaultAndKeyReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyUrl

keyUrl: object

required

required: true = true

serializedName

serializedName: string = "keyUrl"

type

type: object

name

name: "String" = "String"

sourceVault

sourceVault: object

required

required: true = true

serializedName

serializedName: string = "sourceVault"

type

type: object

className

className: string = "SourceVault"

name

name: "Composite" = "Composite"

Const KeyVaultAndSecretReference

KeyVaultAndSecretReference: object

Key Vault Secret Url and vault id of the encryption key

secretUrl

secretUrl: string

Url pointing to a key or secret in KeyVault

sourceVault

sourceVault: SourceVault

Resource id of the KeyVault containing the key or secret

serializedName

serializedName: string = "KeyVaultAndSecretReference"

type

type: object

className

className: string = "KeyVaultAndSecretReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

secretUrl

secretUrl: object

required

required: true = true

serializedName

serializedName: string = "secretUrl"

type

type: object

name

name: "String" = "String"

sourceVault

sourceVault: object

required

required: true = true

serializedName

serializedName: string = "sourceVault"

type

type: object

className

className: string = "SourceVault"

name

name: "Composite" = "Composite"

Const KeyVaultKeyReference

KeyVaultKeyReference: object

Describes a reference to Key Vault Key

keyUrl

keyUrl: string

The URL referencing a key encryption key in Key Vault.

sourceVault

sourceVault: SubResource

The relative URL of the Key Vault containing the key.

serializedName

serializedName: string = "KeyVaultKeyReference"

type

type: object

className

className: string = "KeyVaultKeyReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyUrl

keyUrl: object

required

required: true = true

serializedName

serializedName: string = "keyUrl"

type

type: object

name

name: "String" = "String"

sourceVault

sourceVault: object

required

required: true = true

serializedName

serializedName: string = "sourceVault"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const KeyVaultSecretReference

KeyVaultSecretReference: object

Describes a reference to Key Vault Secret

secretUrl

secretUrl: string

The URL referencing a secret in a Key Vault.

sourceVault

sourceVault: SubResource

The relative URL of the Key Vault containing the secret.

serializedName

serializedName: string = "KeyVaultSecretReference"

type

type: object

className

className: string = "KeyVaultSecretReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

secretUrl

secretUrl: object

required

required: true = true

serializedName

serializedName: string = "secretUrl"

type

type: object

name

name: "String" = "String"

sourceVault

sourceVault: object

required

required: true = true

serializedName

serializedName: string = "sourceVault"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const LinuxConfiguration

LinuxConfiguration: object

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions

For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

Optional disablePasswordAuthentication

disablePasswordAuthentication: undefined | false | true

Specifies whether password authentication should be disabled.

Optional ssh

Specifies the ssh key configuration for a Linux OS.

serializedName

serializedName: string = "LinuxConfiguration"

type

type: object

className

className: string = "LinuxConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disablePasswordAuthentication

disablePasswordAuthentication: object

serializedName

serializedName: string = "disablePasswordAuthentication"

type

type: object

name

name: "Boolean" = "Boolean"

ssh

ssh: object

serializedName

serializedName: string = "ssh"

type

type: object

className

className: string = "SshConfiguration"

name

name: "Composite" = "Composite"

Const ListUsagesResult

ListUsagesResult: object
interface

The List Usages operation response.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.

serializedName

serializedName: string = "ListUsagesResult"

__@iterator

  • __@iterator(): IterableIterator<Usage>
  • Iterator

    Returns IterableIterator<Usage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Usage>[]): Usage[]
  • concat(...items: (T | ConcatArray<T>)[]): Usage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Usage>[]

      Additional items to add to the end of array1.

    Returns Usage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Usage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Usage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Usage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Usage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Usage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Usage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): any
        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Usage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Usage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          • this: void
          • value: Usage
          • index: number
          • obj: Usage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Usage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): void
        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Usage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Usage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Usage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Usage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Usage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Usage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): U
        • Parameters

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Usage | undefined
  • Removes the last element from an array and returns it.

    Returns Usage | undefined

push

  • push(...items: Usage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Usage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Usage
  • reduce(callbackfn: function, initialValue: Usage): Usage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Usage

  • Parameters

    • callbackfn: function
    • initialValue: Usage

    Returns Usage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
        • Parameters

          • previousValue: U
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Usage
  • reduceRight(callbackfn: function, initialValue: Usage): Usage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Usage

  • Parameters

    • callbackfn: function
    • initialValue: Usage

    Returns Usage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
        • Parameters

          • previousValue: U
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Usage[]

shift

  • shift(): Usage | undefined
  • Removes the first element from an array and returns it.

    Returns Usage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Usage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Usage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Usage[]
  • splice(start: number, deleteCount: number, ...items: Usage[]): Usage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Usage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Usage[]

      Elements to insert into the array in place of the deleted elements.

    Returns Usage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Usage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Usage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Usage>
  • Returns an iterable of values in the array

    Returns IterableIterator<Usage>

type

type: object

className

className: string = "ListUsagesResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Usage"

name

name: "Composite" = "Composite"

Const LogAnalyticsInputBase

LogAnalyticsInputBase: object

Api input base class for LogAnalytics Api.

blobContainerSasUri

blobContainerSasUri: string

SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.

fromTime

fromTime: Date

From time of the query

Optional groupByOperationName

groupByOperationName: undefined | false | true

Group query result by Operation Name.

Optional groupByResourceName

groupByResourceName: undefined | false | true

Group query result by Resource Name.

Optional groupByThrottlePolicy

groupByThrottlePolicy: undefined | false | true

Group query result by Throttle Policy applied.

toTime

toTime: Date

To time of the query

serializedName

serializedName: string = "LogAnalyticsInputBase"

type

type: object

className

className: string = "LogAnalyticsInputBase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobContainerSasUri

blobContainerSasUri: object

required

required: true = true

serializedName

serializedName: string = "blobContainerSasUri"

type

type: object

name

name: "String" = "String"

fromTime

fromTime: object

required

required: true = true

serializedName

serializedName: string = "fromTime"

type

type: object

name

name: "DateTime" = "DateTime"

groupByOperationName

groupByOperationName: object

serializedName

serializedName: string = "groupByOperationName"

type

type: object

name

name: "Boolean" = "Boolean"

groupByResourceName

groupByResourceName: object

serializedName

serializedName: string = "groupByResourceName"

type

type: object

name

name: "Boolean" = "Boolean"

groupByThrottlePolicy

groupByThrottlePolicy: object

serializedName

serializedName: string = "groupByThrottlePolicy"

type

type: object

name

name: "Boolean" = "Boolean"

toTime

toTime: object

required

required: true = true

serializedName

serializedName: string = "toTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const LogAnalyticsOperationResult

LogAnalyticsOperationResult: object

LogAnalytics operation status response

Optional endTime

endTime: Date

End time of the operation NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

error: ApiError

Api error NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Operation ID NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: LogAnalyticsOutput

LogAnalyticsOutput NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

Start time of the operation NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: undefined | string

Operation status NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LogAnalyticsOperationResult"

type

type: object

className

className: string = "LogAnalyticsOperationResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "LogAnalyticsOutput"

name

name: "Composite" = "Composite"

Const LogAnalyticsOutput

LogAnalyticsOutput: object

LogAnalytics output properties

Optional output

output: undefined | string

Output file Uri path to blob container. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LogAnalyticsOutput"

type

type: object

className

className: string = "LogAnalyticsOutput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

output

output: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "output"

type

type: object

name

name: "String" = "String"

Const MaintenanceRedeployStatus

MaintenanceRedeployStatus: object

Maintenance Operation Status.

Optional isCustomerInitiatedMaintenanceAllowed

isCustomerInitiatedMaintenanceAllowed: undefined | false | true

True, if customer is allowed to perform Maintenance.

Optional lastOperationMessage

lastOperationMessage: undefined | string

Message returned for the last Maintenance Operation.

Optional lastOperationResultCode

lastOperationResultCode: MaintenanceOperationResultCodeTypes

The Last Maintenance Operation Result Code. Possible values include: 'None', 'RetryLater', 'MaintenanceAborted', 'MaintenanceCompleted'

Optional maintenanceWindowEndTime

maintenanceWindowEndTime: Date

End Time for the Maintenance Window.

Optional maintenanceWindowStartTime

maintenanceWindowStartTime: Date

Start Time for the Maintenance Window.

Optional preMaintenanceWindowEndTime

preMaintenanceWindowEndTime: Date

End Time for the Pre Maintenance Window.

Optional preMaintenanceWindowStartTime

preMaintenanceWindowStartTime: Date

Start Time for the Pre Maintenance Window.

serializedName

serializedName: string = "MaintenanceRedeployStatus"

type

type: object

className

className: string = "MaintenanceRedeployStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isCustomerInitiatedMaintenanceAllowed

isCustomerInitiatedMaintenanceAllowed: object

serializedName

serializedName: string = "isCustomerInitiatedMaintenanceAllowed"

type

type: object

name

name: "Boolean" = "Boolean"

lastOperationMessage

lastOperationMessage: object

serializedName

serializedName: string = "lastOperationMessage"

type

type: object

name

name: "String" = "String"

lastOperationResultCode

lastOperationResultCode: object

serializedName

serializedName: string = "lastOperationResultCode"

type

type: object

allowedValues

allowedValues: string[] = ["None","RetryLater","MaintenanceAborted","MaintenanceCompleted"]

name

name: "Enum" = "Enum"

maintenanceWindowEndTime

maintenanceWindowEndTime: object

serializedName

serializedName: string = "maintenanceWindowEndTime"

type

type: object

name

name: "DateTime" = "DateTime"

maintenanceWindowStartTime

maintenanceWindowStartTime: object

serializedName

serializedName: string = "maintenanceWindowStartTime"

type

type: object

name

name: "DateTime" = "DateTime"

preMaintenanceWindowEndTime

preMaintenanceWindowEndTime: object

serializedName

serializedName: string = "preMaintenanceWindowEndTime"

type

type: object

name

name: "DateTime" = "DateTime"

preMaintenanceWindowStartTime

preMaintenanceWindowStartTime: object

serializedName

serializedName: string = "preMaintenanceWindowStartTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ManagedDiskParameters

ManagedDiskParameters: object

The parameters of a managed disk.

Optional id

id: undefined | string

Resource Id

Optional storageAccountType

storageAccountType: StorageAccountTypes

Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

serializedName

serializedName: string = "ManagedDiskParameters"

type

type: object

className

className: string = "ManagedDiskParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

storageAccountType

storageAccountType: object

serializedName

serializedName: string = "storageAccountType"

type

type: object

name

name: "String" = "String"

Const NetworkInterfaceReference

NetworkInterfaceReference: object

Describes a network interface reference.

Optional id

id: undefined | string

Resource Id

Optional primary

primary: undefined | false | true

Specifies the primary network interface in case the virtual machine has more than 1 network interface.

serializedName

serializedName: string = "NetworkInterfaceReference"

type

type: object

className

className: string = "NetworkInterfaceReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

primary

primary: object

serializedName

serializedName: string = "properties.primary"

type

type: object

name

name: "Boolean" = "Boolean"

Const NetworkProfile

NetworkProfile: object

Specifies the network interfaces of the virtual machine.

Optional networkInterfaces

networkInterfaces: NetworkInterfaceReference[]

Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

serializedName

serializedName: string = "NetworkProfile"

type

type: object

className

className: string = "NetworkProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkInterfaces

networkInterfaces: object

serializedName

serializedName: string = "networkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceReference"

name

name: "Composite" = "Composite"

Const OSDisk

OSDisk: object

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Optional caching

caching: CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

createOption

createOption: DiskCreateOptionTypes

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach'

Optional diskSizeGB

diskSizeGB: undefined | number

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

Optional encryptionSettings

encryptionSettings: DiskEncryptionSettings

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

Optional image

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Optional managedDisk

The managed disk parameters.

Optional name

name: undefined | string

The disk name.

Optional osType

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

Windows

Linux. Possible values include: 'Windows', 'Linux'

Optional vhd

The virtual hard disk.

Optional writeAcceleratorEnabled

writeAcceleratorEnabled: undefined | false | true

Specifies whether writeAccelerator should be enabled or disabled on the disk.

serializedName

serializedName: string = "OSDisk"

type

type: object

className

className: string = "OSDisk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

caching

caching: object

serializedName

serializedName: string = "caching"

type

type: object

allowedValues

allowedValues: string[] = ["None","ReadOnly","ReadWrite"]

name

name: "Enum" = "Enum"

createOption

createOption: object

required

required: true = true

serializedName

serializedName: string = "createOption"

type

type: object

name

name: "String" = "String"

diskSizeGB

diskSizeGB: object

serializedName

serializedName: string = "diskSizeGB"

type

type: object

name

name: "Number" = "Number"

encryptionSettings

encryptionSettings: object

serializedName

serializedName: string = "encryptionSettings"

type

type: object

className

className: string = "DiskEncryptionSettings"

name

name: "Composite" = "Composite"

image

image: object

serializedName

serializedName: string = "image"

type

type: object

className

className: string = "VirtualHardDisk"

name

name: "Composite" = "Composite"

managedDisk

managedDisk: object

serializedName

serializedName: string = "managedDisk"

type

type: object

className

className: string = "ManagedDiskParameters"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

allowedValues

allowedValues: string[] = ["Windows","Linux"]

name

name: "Enum" = "Enum"

vhd

vhd: object

serializedName

serializedName: string = "vhd"

type

type: object

className

className: string = "VirtualHardDisk"

name

name: "Composite" = "Composite"

writeAcceleratorEnabled

writeAcceleratorEnabled: object

serializedName

serializedName: string = "writeAcceleratorEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const OSDiskImage

OSDiskImage: object

Contains the os disk image information.

operatingSystem

operatingSystem: OperatingSystemTypes

The operating system of the osDiskImage. Possible values include: 'Windows', 'Linux'

serializedName

serializedName: string = "OSDiskImage"

type

type: object

className

className: string = "OSDiskImage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operatingSystem

operatingSystem: object

required

required: true = true

serializedName

serializedName: string = "operatingSystem"

type

type: object

allowedValues

allowedValues: string[] = ["Windows","Linux"]

name

name: "Enum" = "Enum"

Const OSProfile

OSProfile: object

Specifies the operating system settings for the virtual machine.

Optional adminPassword

adminPassword: undefined | string

Specifies the password of the administrator account.

Minimum-length (Windows): 8 characters

Minimum-length (Linux): 6 characters

Max-length (Windows): 123 characters

Max-length (Linux): 72 characters

Complexity requirements: 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM

For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

Optional adminUsername

adminUsername: undefined | string

Specifies the name of the administrator account.

Windows-only restriction: Cannot end in "."

Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

Minimum-length (Linux): 1 character

Max-length (Linux): 64 characters

Max-length (Windows): 20 characters

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • Optional computerName

    computerName: undefined | string

    Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    Max-length (Windows): 15 characters

    Max-length (Linux): 64 characters.

    For naming conventions and restrictions see Azure infrastructure services implementation guidelines.

    Optional customData

    customData: undefined | string

    Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    Optional linuxConfiguration

    linuxConfiguration: LinuxConfiguration

    Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions

    For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    Optional secrets

    secrets: VaultSecretGroup[]

    Specifies set of certificates that should be installed onto the virtual machine.

    Optional windowsConfiguration

    windowsConfiguration: WindowsConfiguration

    Specifies Windows operating system settings on the virtual machine.

    serializedName

    serializedName: string = "OSProfile"

    type

    type: object

    className

    className: string = "OSProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    adminPassword

    adminPassword: object

    serializedName

    serializedName: string = "adminPassword"

    type

    type: object

    name

    name: "String" = "String"

    adminUsername

    adminUsername: object

    serializedName

    serializedName: string = "adminUsername"

    type

    type: object

    name

    name: "String" = "String"

    computerName

    computerName: object

    serializedName

    serializedName: string = "computerName"

    type

    type: object

    name

    name: "String" = "String"

    customData

    customData: object

    serializedName

    serializedName: string = "customData"

    type

    type: object

    name

    name: "String" = "String"

    linuxConfiguration

    linuxConfiguration: object

    serializedName

    serializedName: string = "linuxConfiguration"

    type

    type: object

    className

    className: string = "LinuxConfiguration"

    name

    name: "Composite" = "Composite"

    secrets

    secrets: object

    serializedName

    serializedName: string = "secrets"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VaultSecretGroup"

    name

    name: "Composite" = "Composite"

    windowsConfiguration

    windowsConfiguration: object

    serializedName

    serializedName: string = "windowsConfiguration"

    type

    type: object

    className

    className: string = "WindowsConfiguration"

    name

    name: "Composite" = "Composite"

    Const OperationStatusResponse

    OperationStatusResponse: object

    Operation status response

    Optional endTime

    endTime: Date

    End time of the operation NOTE: This property will not be serialized. It can only be populated by the server.

    Optional error

    error: ApiError

    Api error NOTE: This property will not be serialized. It can only be populated by the server.

    Optional name

    name: undefined | string

    Operation ID NOTE: This property will not be serialized. It can only be populated by the server.

    Optional startTime

    startTime: Date

    Start time of the operation NOTE: This property will not be serialized. It can only be populated by the server.

    Optional status

    status: undefined | string

    Operation status NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "OperationStatusResponse"

    type

    type: object

    className

    className: string = "OperationStatusResponse"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    endTime

    endTime: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "endTime"

    type

    type: object

    name

    name: "DateTime" = "DateTime"

    error

    error: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "error"

    type

    type: object

    className

    className: string = "ApiError"

    name

    name: "Composite" = "Composite"

    name

    name: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    startTime

    startTime: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "startTime"

    type

    type: object

    name

    name: "DateTime" = "DateTime"

    status

    status: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "status"

    type

    type: object

    name

    name: "String" = "String"

    Const Plan

    Plan: object

    Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

    Optional name

    name: undefined | string

    The plan ID.

    Optional product

    product: undefined | string

    Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

    Optional promotionCode

    promotionCode: undefined | string

    The promotion code.

    Optional publisher

    publisher: undefined | string

    The publisher ID.

    serializedName

    serializedName: string = "Plan"

    type

    type: object

    className

    className: string = "Plan"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    product

    product: object

    serializedName

    serializedName: string = "product"

    type

    type: object

    name

    name: "String" = "String"

    promotionCode

    promotionCode: object

    serializedName

    serializedName: string = "promotionCode"

    type

    type: object

    name

    name: "String" = "String"

    publisher

    publisher: object

    serializedName

    serializedName: string = "publisher"

    type

    type: object

    name

    name: "String" = "String"

    Const PurchasePlan

    PurchasePlan: object

    Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

    name

    name: string

    The plan ID.

    product

    product: string

    Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

    publisher

    publisher: string

    The publisher ID.

    serializedName

    serializedName: string = "PurchasePlan"

    type

    type: object

    className

    className: string = "PurchasePlan"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    name

    name: object

    required

    required: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    product

    product: object

    required

    required: true = true

    serializedName

    serializedName: string = "product"

    type

    type: object

    name

    name: "String" = "String"

    publisher

    publisher: object

    required

    required: true = true

    serializedName

    serializedName: string = "publisher"

    type

    type: object

    name

    name: "String" = "String"

    Const RecoveryWalkResponse

    RecoveryWalkResponse: object

    Response after calling a manual recovery walk

    Optional nextPlatformUpdateDomain

    nextPlatformUpdateDomain: undefined | number

    The next update domain that needs to be walked. Null means walk spanning all update domains has been completed NOTE: This property will not be serialized. It can only be populated by the server.

    Optional walkPerformed

    walkPerformed: undefined | false | true

    Whether the recovery walk was performed NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "RecoveryWalkResponse"

    type

    type: object

    className

    className: string = "RecoveryWalkResponse"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextPlatformUpdateDomain

    nextPlatformUpdateDomain: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "nextPlatformUpdateDomain"

    type

    type: object

    name

    name: "Number" = "Number"

    walkPerformed

    walkPerformed: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "walkPerformed"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    Const RequestRateByIntervalInput

    RequestRateByIntervalInput: object

    Api request input for LogAnalytics getRequestRateByInterval Api.

    blobContainerSasUri

    blobContainerSasUri: string

    SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.

    fromTime

    fromTime: Date

    From time of the query

    Optional groupByOperationName

    groupByOperationName: undefined | false | true

    Group query result by Operation Name.

    Optional groupByResourceName

    groupByResourceName: undefined | false | true

    Group query result by Resource Name.

    Optional groupByThrottlePolicy

    groupByThrottlePolicy: undefined | false | true

    Group query result by Throttle Policy applied.

    intervalLength

    intervalLength: IntervalInMins

    Interval value in minutes used to create LogAnalytics call rate logs. Possible values include: 'ThreeMins', 'FiveMins', 'ThirtyMins', 'SixtyMins'

    toTime

    toTime: Date

    To time of the query

    serializedName

    serializedName: string = "RequestRateByIntervalInput"

    type

    type: object

    className

    className: string = "RequestRateByIntervalInput"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    intervalLength

    intervalLength: object

    required

    required: true = true

    serializedName

    serializedName: string = "intervalLength"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["ThreeMins","FiveMins","ThirtyMins","SixtyMins"]

    name

    name: "Enum" = "Enum"

    Const Resource

    Resource: object

    The Resource model definition.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    location

    location: string

    Resource location

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    Optional tags

    tags: undefined | object

    Resource tags

    serializedName

    serializedName: string = "Resource"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "Resource"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    id

    id: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "id"

    type

    type: object

    name

    name: "String" = "String"

    location

    location: object

    required

    required: true = true

    serializedName

    serializedName: string = "location"

    type

    type: object

    name

    name: "String" = "String"

    name

    name: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    tags

    tags: object

    serializedName

    serializedName: string = "tags"

    type

    type: object

    name

    name: "Dictionary" = "Dictionary"

    value

    value: object

    type

    type: object

    name

    name: "String" = "String"

    type

    type: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "type"

    type

    type: object

    name

    name: "String" = "String"

    Const ResourceUpdate

    ResourceUpdate: object

    The Resource model definition.

    Optional sku

    sku: DiskSku

    Optional tags

    tags: undefined | object

    Resource tags

    serializedName

    serializedName: string = "ResourceUpdate"

    type

    type: object

    className

    className: string = "ResourceUpdate"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    sku

    sku: object

    serializedName

    serializedName: string = "sku"

    type

    type: object

    className

    className: string = "DiskSku"

    name

    name: "Composite" = "Composite"

    tags

    tags: object

    serializedName

    serializedName: string = "tags"

    type

    type: object

    name

    name: "Dictionary" = "Dictionary"

    value

    value: object

    type

    type: object

    name

    name: "String" = "String"

    Const RollbackStatusInfo

    RollbackStatusInfo: object

    Information about rollback on failed VM instances after a OS Upgrade operation.

    Optional failedRolledbackInstanceCount

    failedRolledbackInstanceCount: undefined | number

    The number of instances which failed to rollback. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional rollbackError

    rollbackError: ApiError

    Error details if OS rollback failed. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional successfullyRolledbackInstanceCount

    successfullyRolledbackInstanceCount: undefined | number

    The number of instances which have been successfully rolled back. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "RollbackStatusInfo"

    type

    type: object

    className

    className: string = "RollbackStatusInfo"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    failedRolledbackInstanceCount

    failedRolledbackInstanceCount: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "failedRolledbackInstanceCount"

    type

    type: object

    name

    name: "Number" = "Number"

    rollbackError

    rollbackError: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "rollbackError"

    type

    type: object

    className

    className: string = "ApiError"

    name

    name: "Composite" = "Composite"

    successfullyRolledbackInstanceCount

    successfullyRolledbackInstanceCount: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "successfullyRolledbackInstanceCount"

    type

    type: object

    name

    name: "Number" = "Number"

    Const RollingUpgradePolicy

    RollingUpgradePolicy: object

    The configuration parameters used while performing a rolling upgrade.

    Optional maxBatchInstancePercent

    maxBatchInstancePercent: undefined | number

    The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.

    Optional maxUnhealthyInstancePercent

    maxUnhealthyInstancePercent: undefined | number

    The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.

    Optional maxUnhealthyUpgradedInstancePercent

    maxUnhealthyUpgradedInstancePercent: undefined | number

    The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.

    Optional pauseTimeBetweenBatches

    pauseTimeBetweenBatches: undefined | string

    The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).

    serializedName

    serializedName: string = "RollingUpgradePolicy"

    type

    type: object

    className

    className: string = "RollingUpgradePolicy"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    maxBatchInstancePercent

    maxBatchInstancePercent: object

    serializedName

    serializedName: string = "maxBatchInstancePercent"

    constraints

    constraints: object

    InclusiveMaximum

    InclusiveMaximum: number = 100

    InclusiveMinimum

    InclusiveMinimum: number = 5

    type

    type: object

    name

    name: "Number" = "Number"

    maxUnhealthyInstancePercent

    maxUnhealthyInstancePercent: object

    serializedName

    serializedName: string = "maxUnhealthyInstancePercent"

    constraints

    constraints: object

    InclusiveMaximum

    InclusiveMaximum: number = 100

    InclusiveMinimum

    InclusiveMinimum: number = 5

    type

    type: object

    name

    name: "Number" = "Number"

    maxUnhealthyUpgradedInstancePercent

    maxUnhealthyUpgradedInstancePercent: object

    serializedName

    serializedName: string = "maxUnhealthyUpgradedInstancePercent"

    constraints

    constraints: object

    InclusiveMaximum

    InclusiveMaximum: number = 100

    InclusiveMinimum

    InclusiveMinimum: number = 0

    type

    type: object

    name

    name: "Number" = "Number"

    pauseTimeBetweenBatches

    pauseTimeBetweenBatches: object

    serializedName

    serializedName: string = "pauseTimeBetweenBatches"

    type

    type: object

    name

    name: "String" = "String"

    Const RollingUpgradeProgressInfo

    RollingUpgradeProgressInfo: object

    Information about the number of virtual machine instances in each upgrade state.

    Optional failedInstanceCount

    failedInstanceCount: undefined | number

    The number of instances that have failed to be upgraded successfully. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional inProgressInstanceCount

    inProgressInstanceCount: undefined | number

    The number of instances that are currently being upgraded. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional pendingInstanceCount

    pendingInstanceCount: undefined | number

    The number of instances that have not yet begun to be upgraded. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional successfulInstanceCount

    successfulInstanceCount: undefined | number

    The number of instances that have been successfully upgraded. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "RollingUpgradeProgressInfo"

    type

    type: object

    className

    className: string = "RollingUpgradeProgressInfo"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    failedInstanceCount

    failedInstanceCount: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "failedInstanceCount"

    type

    type: object

    name

    name: "Number" = "Number"

    inProgressInstanceCount

    inProgressInstanceCount: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "inProgressInstanceCount"

    type

    type: object

    name

    name: "Number" = "Number"

    pendingInstanceCount

    pendingInstanceCount: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "pendingInstanceCount"

    type

    type: object

    name

    name: "Number" = "Number"

    successfulInstanceCount

    successfulInstanceCount: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "successfulInstanceCount"

    type

    type: object

    name

    name: "Number" = "Number"

    Const RollingUpgradeRunningStatus

    RollingUpgradeRunningStatus: object

    Information about the current running state of the overall upgrade.

    Optional code

    Code indicating the current status of the upgrade. Possible values include: 'RollingForward', 'Cancelled', 'Completed', 'Faulted' NOTE: This property will not be serialized. It can only be populated by the server.

    Optional lastAction

    The last action performed on the rolling upgrade. Possible values include: 'Start', 'Cancel' NOTE: This property will not be serialized. It can only be populated by the server.

    Optional lastActionTime

    lastActionTime: Date

    Last action time of the upgrade. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional startTime

    startTime: Date

    Start time of the upgrade. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "RollingUpgradeRunningStatus"

    type

    type: object

    className

    className: string = "RollingUpgradeRunningStatus"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    code

    code: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "code"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["RollingForward","Cancelled","Completed","Faulted"]

    name

    name: "Enum" = "Enum"

    lastAction

    lastAction: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "lastAction"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Start","Cancel"]

    name

    name: "Enum" = "Enum"

    lastActionTime

    lastActionTime: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "lastActionTime"

    type

    type: object

    name

    name: "DateTime" = "DateTime"

    startTime

    startTime: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "startTime"

    type

    type: object

    name

    name: "DateTime" = "DateTime"

    Const RollingUpgradeStatusInfo

    RollingUpgradeStatusInfo: object

    The status of the latest virtual machine scale set rolling upgrade.

    Optional error

    error: ApiError

    Error details for this upgrade, if there are any. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    location

    location: string

    Resource location

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    Optional policy

    The rolling upgrade policies applied for this upgrade. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional progress

    Information about the number of virtual machine instances in each upgrade state. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional runningStatus

    Information about the current running state of the overall upgrade. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional tags

    tags: undefined | object

    Resource tags

    serializedName

    serializedName: string = "RollingUpgradeStatusInfo"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "RollingUpgradeStatusInfo"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    error

    error: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.error"

    type

    type: object

    className

    className: string = "ApiError"

    name

    name: "Composite" = "Composite"

    policy

    policy: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.policy"

    type

    type: object

    className

    className: string = "RollingUpgradePolicy"

    name

    name: "Composite" = "Composite"

    progress

    progress: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.progress"

    type

    type: object

    className

    className: string = "RollingUpgradeProgressInfo"

    name

    name: "Composite" = "Composite"

    runningStatus

    runningStatus: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.runningStatus"

    type

    type: object

    className

    className: string = "RollingUpgradeRunningStatus"

    name

    name: "Composite" = "Composite"

    Const Sku

    Sku: object

    Describes a virtual machine scale set sku.

    Optional capacity

    capacity: undefined | number

    Specifies the number of virtual machines in the scale set.

    Optional name

    name: undefined | string

    The sku name.

    Optional tier

    tier: undefined | string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    serializedName

    serializedName: string = "Sku"

    type

    type: object

    className

    className: string = "Sku"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    capacity

    capacity: object

    serializedName

    serializedName: string = "capacity"

    type

    type: object

    name

    name: "Number" = "Number"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    tier

    tier: object

    serializedName

    serializedName: string = "tier"

    type

    type: object

    name

    name: "String" = "String"

    Const Snapshot

    Snapshot: object

    Snapshot resource.

    creationData

    creationData: CreationData

    Disk source information. CreationData information cannot be changed after the disk has been created.

    Optional diskSizeGB

    diskSizeGB: undefined | number

    If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

    Optional encryptionSettings

    encryptionSettings: EncryptionSettings

    Encryption settings for disk or snapshot

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    location

    location: string

    Resource location

    Optional managedBy

    managedBy: undefined | string

    Unused. Always Null. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    Optional osType

    The Operating System type. Possible values include: 'Windows', 'Linux'

    Optional provisioningState

    provisioningState: undefined | string

    The disk provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional sku

    sku: DiskSku

    Optional tags

    tags: undefined | object

    Resource tags

    Optional timeCreated

    timeCreated: Date

    The time when the disk was created. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "Snapshot"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "Snapshot"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    creationData

    creationData: object

    required

    required: true = true

    serializedName

    serializedName: string = "properties.creationData"

    type

    type: object

    className

    className: string = "CreationData"

    name

    name: "Composite" = "Composite"

    diskSizeGB

    diskSizeGB: object

    serializedName

    serializedName: string = "properties.diskSizeGB"

    type

    type: object

    name

    name: "Number" = "Number"

    encryptionSettings

    encryptionSettings: object

    serializedName

    serializedName: string = "properties.encryptionSettings"

    type

    type: object

    className

    className: string = "EncryptionSettings"

    name

    name: "Composite" = "Composite"

    managedBy

    managedBy: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "managedBy"

    type

    type: object

    name

    name: "String" = "String"

    osType

    osType: object

    serializedName

    serializedName: string = "properties.osType"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Windows","Linux"]

    name

    name: "Enum" = "Enum"

    provisioningState

    provisioningState: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.provisioningState"

    type

    type: object

    name

    name: "String" = "String"

    sku

    sku: object

    serializedName

    serializedName: string = "sku"

    type

    type: object

    className

    className: string = "DiskSku"

    name

    name: "Composite" = "Composite"

    timeCreated

    timeCreated: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.timeCreated"

    type

    type: object

    name

    name: "DateTime" = "DateTime"

    Const SnapshotList

    SnapshotList: object
    interface

    The List Snapshots operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots.

    serializedName

    serializedName: string = "SnapshotList"

    __@iterator

    • __@iterator(): IterableIterator<Snapshot>
    • Iterator

      Returns IterableIterator<Snapshot>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      • Rest ...items: ConcatArray<Snapshot>[]

        Additional items to add to the end of array1.

      Returns Snapshot[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns Snapshot[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • entries(): IterableIterator<[number, Snapshot]>
    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, Snapshot]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    fill

    • fill(value: Snapshot, start?: undefined | number, end?: undefined | number): this
    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: Snapshot

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter<S>(callbackfn: function, thisArg?: any): S[]
    • filter(callbackfn: function, thisArg?: any): Snapshot[]
    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns Snapshot[]

    find

    • find<S>(predicate: function, thisArg?: any): S | undefined
    • find(predicate: function, thisArg?: any): Snapshot | undefined
    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type parameters

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns S | undefined

    • Parameters

      • predicate: function
      • Optional thisArg: any

      Returns Snapshot | undefined

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    includes

    • includes(searchElement: Snapshot, fromIndex?: undefined | number): boolean
    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: Snapshot

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement: Snapshot, fromIndex?: undefined | number): number
    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: Snapshot

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • lastIndexOf(searchElement: Snapshot, fromIndex?: undefined | number): number
    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: Snapshot

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns Snapshot | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      • Rest ...items: Snapshot[]

        New elements of the Array.

      Returns number

    reduce

    • reduce(callbackfn: function): Snapshot
    • reduce(callbackfn: function, initialValue: Snapshot): Snapshot
    • reduce<U>(callbackfn: function, initialValue: U): U
    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

      Returns Snapshot

    • Parameters

      Returns Snapshot

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          • (previousValue: U, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): U
          • Parameters

            • previousValue: U
            • currentValue: Snapshot
            • currentIndex: number
            • array: Snapshot[]

            Returns U

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    reduceRight

    • reduceRight(callbackfn: function): Snapshot
    • reduceRight(callbackfn: function, initialValue: Snapshot): Snapshot
    • reduceRight<U>(callbackfn: function, initialValue: U): U
    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

      Returns Snapshot

    • Parameters

      Returns Snapshot

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          • (previousValue: U, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): U
          • Parameters

            • previousValue: U
            • currentValue: Snapshot
            • currentIndex: number
            • array: Snapshot[]

            Returns U

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    reverse

    • Reverses the elements in an Array.

      Returns Snapshot[]

    shift

    • Removes the first element from an array and returns it.

      Returns Snapshot | undefined

    slice

    • slice(start?: undefined | number, end?: undefined | number): Snapshot[]
    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns Snapshot[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • splice(start: number, deleteCount?: undefined | number): Snapshot[]
    • splice(start: number, deleteCount: number, ...items: Snapshot[]): Snapshot[]
    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns Snapshot[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: Snapshot[]

        Elements to insert into the array in place of the deleted elements.

      Returns Snapshot[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      • Rest ...items: Snapshot[]

        Elements to insert at the start of the Array.

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<Snapshot>

    type

    type: object

    className

    className: string = "SnapshotList"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "Snapshot"

    name

    name: "Composite" = "Composite"

    Const SnapshotUpdate

    SnapshotUpdate: object

    Snapshot update resource.

    Optional diskSizeGB

    diskSizeGB: undefined | number

    If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

    Optional encryptionSettings

    encryptionSettings: EncryptionSettings

    Encryption settings for disk or snapshot

    Optional osType

    the Operating System type. Possible values include: 'Windows', 'Linux'

    Optional sku

    sku: DiskSku

    Optional tags

    tags: undefined | object

    Resource tags

    serializedName

    serializedName: string = "SnapshotUpdate"

    type

    type: object

    className

    className: string = "SnapshotUpdate"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    diskSizeGB

    diskSizeGB: object

    serializedName

    serializedName: string = "properties.diskSizeGB"

    type

    type: object

    name

    name: "Number" = "Number"

    encryptionSettings

    encryptionSettings: object

    serializedName

    serializedName: string = "properties.encryptionSettings"

    type

    type: object

    className

    className: string = "EncryptionSettings"

    name

    name: "Composite" = "Composite"

    osType

    osType: object

    serializedName

    serializedName: string = "properties.osType"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Windows","Linux"]

    name

    name: "Enum" = "Enum"

    Const SourceVault

    SourceVault: object

    The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

    Optional id

    id: undefined | string

    Resource Id

    serializedName

    serializedName: string = "SourceVault"

    type

    type: object

    className

    className: string = "SourceVault"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    id

    id: object

    serializedName

    serializedName: string = "id"

    type

    type: object

    name

    name: "String" = "String"

    Const SshConfiguration

    SshConfiguration: object

    SSH configuration for Linux based VMs running on Azure

    Optional publicKeys

    publicKeys: SshPublicKey[]

    The list of SSH public keys used to authenticate with linux based VMs.

    serializedName

    serializedName: string = "SshConfiguration"

    type

    type: object

    className

    className: string = "SshConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    publicKeys

    publicKeys: object

    serializedName

    serializedName: string = "publicKeys"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "SshPublicKey"

    name

    name: "Composite" = "Composite"

    Const SshPublicKey

    SshPublicKey: object

    Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

    Optional keyData

    keyData: undefined | string

    SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

    For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.

    Optional path

    path: undefined | string

    Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

    serializedName

    serializedName: string = "SshPublicKey"

    type

    type: object

    className

    className: string = "SshPublicKey"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    keyData

    keyData: object

    serializedName

    serializedName: string = "keyData"

    type

    type: object

    name

    name: "String" = "String"

    path

    path: object

    serializedName

    serializedName: string = "path"

    type

    type: object

    name

    name: "String" = "String"

    Const StorageProfile

    StorageProfile: object

    Specifies the storage settings for the virtual machine disks.

    Optional dataDisks

    dataDisks: DataDisk[]

    Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see About disks and VHDs for Azure virtual machines.

    Optional imageReference

    imageReference: ImageReference

    Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.

    Optional osDisk

    osDisk: OSDisk

    Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see About disks and VHDs for Azure virtual machines.

    serializedName

    serializedName: string = "StorageProfile"

    type

    type: object

    className

    className: string = "StorageProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dataDisks

    dataDisks: object

    serializedName

    serializedName: string = "dataDisks"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "DataDisk"

    name

    name: "Composite" = "Composite"

    imageReference

    imageReference: object

    serializedName

    serializedName: string = "imageReference"

    type

    type: object

    className

    className: string = "ImageReference"

    name

    name: "Composite" = "Composite"

    osDisk

    osDisk: object

    serializedName

    serializedName: string = "osDisk"

    type

    type: object

    className

    className: string = "OSDisk"

    name

    name: "Composite" = "Composite"

    Const SubResource

    SubResource: object

    An interface representing SubResource.

    Optional id

    id: undefined | string

    Resource Id

    serializedName

    serializedName: string = "SubResource"

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    id

    id: object

    serializedName

    serializedName: string = "id"

    type

    type: object

    name

    name: "String" = "String"

    Const SubResourceReadOnly

    SubResourceReadOnly: object

    An interface representing SubResourceReadOnly.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "SubResourceReadOnly"

    type

    type: object

    className

    className: string = "SubResourceReadOnly"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    id

    id: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "id"

    type

    type: object

    name

    name: "String" = "String"

    Const ThrottledRequestsInput

    ThrottledRequestsInput: object

    Api request input for LogAnalytics getThrottledRequests Api.

    blobContainerSasUri

    blobContainerSasUri: string

    SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.

    fromTime

    fromTime: Date

    From time of the query

    Optional groupByOperationName

    groupByOperationName: undefined | false | true

    Group query result by Operation Name.

    Optional groupByResourceName

    groupByResourceName: undefined | false | true

    Group query result by Resource Name.

    Optional groupByThrottlePolicy

    groupByThrottlePolicy: undefined | false | true

    Group query result by Throttle Policy applied.

    toTime

    toTime: Date

    To time of the query

    serializedName

    serializedName: string = "ThrottledRequestsInput"

    type

    type: object

    className

    className: string = "ThrottledRequestsInput"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    Const UpdateResource

    UpdateResource: object

    The Update Resource model definition.

    Optional tags

    tags: undefined | object

    Resource tags

    serializedName

    serializedName: string = "UpdateResource"

    type

    type: object

    className

    className: string = "UpdateResource"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    tags

    tags: object

    serializedName

    serializedName: string = "tags"

    type

    type: object

    name

    name: "Dictionary" = "Dictionary"

    value

    value: object

    type

    type: object

    name

    name: "String" = "String"

    Const UpgradeOperationHistoricalStatusInfo

    UpgradeOperationHistoricalStatusInfo: object

    Virtual Machine Scale Set OS Upgrade History operation response.

    Optional location

    location: undefined | string

    Resource location NOTE: This property will not be serialized. It can only be populated by the server.

    Optional properties

    Information about the properties of the upgrade operation. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "UpgradeOperationHistoricalStatusInfo"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "UpgradeOperationHistoricalStatusInfo"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    location

    location: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "location"

    type

    type: object

    name

    name: "String" = "String"

    properties

    properties: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties"

    type

    type: object

    className

    className: string = "UpgradeOperationHistoricalStatusInfoProperties"

    name

    name: "Composite" = "Composite"

    type

    type: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "type"

    type

    type: object

    name

    name: "String" = "String"

    Const UpgradeOperationHistoricalStatusInfoProperties

    UpgradeOperationHistoricalStatusInfoProperties: object

    Describes each OS upgrade on the Virtual Machine Scale Set.

    Optional error

    error: ApiError

    Error Details for this upgrade if there are any. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional progress

    Counts of the VMs in each state. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional rollbackInfo

    rollbackInfo: RollbackStatusInfo

    Information about OS rollback if performed NOTE: This property will not be serialized. It can only be populated by the server.

    Optional runningStatus

    Information about the overall status of the upgrade operation. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional startedBy

    Invoker of the Upgrade Operation. Possible values include: 'Unknown', 'User', 'Platform' NOTE: This property will not be serialized. It can only be populated by the server.

    Optional targetImageReference

    targetImageReference: ImageReference

    Image Reference details NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "UpgradeOperationHistoricalStatusInfoProperties"

    type

    type: object

    className

    className: string = "UpgradeOperationHistoricalStatusInfoProperties"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    error

    error: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "error"

    type

    type: object

    className

    className: string = "ApiError"

    name

    name: "Composite" = "Composite"

    progress

    progress: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "progress"

    type

    type: object

    className

    className: string = "RollingUpgradeProgressInfo"

    name

    name: "Composite" = "Composite"

    rollbackInfo

    rollbackInfo: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "rollbackInfo"

    type

    type: object

    className

    className: string = "RollbackStatusInfo"

    name

    name: "Composite" = "Composite"

    runningStatus

    runningStatus: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "runningStatus"

    type

    type: object

    className

    className: string = "UpgradeOperationHistoryStatus"

    name

    name: "Composite" = "Composite"

    startedBy

    startedBy: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "startedBy"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Unknown","User","Platform"]

    name

    name: "Enum" = "Enum"

    targetImageReference

    targetImageReference: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "targetImageReference"

    type

    type: object

    className

    className: string = "ImageReference"

    name

    name: "Composite" = "Composite"

    Const UpgradeOperationHistoryStatus

    UpgradeOperationHistoryStatus: object

    Information about the current running state of the overall upgrade.

    Optional code

    Code indicating the current status of the upgrade. Possible values include: 'RollingForward', 'Cancelled', 'Completed', 'Faulted' NOTE: This property will not be serialized. It can only be populated by the server.

    Optional endTime

    endTime: Date

    End time of the upgrade. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional startTime

    startTime: Date

    Start time of the upgrade. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "UpgradeOperationHistoryStatus"

    type

    type: object

    className

    className: string = "UpgradeOperationHistoryStatus"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    code

    code: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "code"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["RollingForward","Cancelled","Completed","Faulted"]

    name

    name: "Enum" = "Enum"

    endTime

    endTime: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "endTime"

    type

    type: object

    name

    name: "DateTime" = "DateTime"

    startTime

    startTime: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "startTime"

    type

    type: object

    name

    name: "DateTime" = "DateTime"

    Const UpgradePolicy

    UpgradePolicy: object

    Describes an upgrade policy - automatic, manual, or rolling.

    Optional autoOSUpgradePolicy

    autoOSUpgradePolicy: AutoOSUpgradePolicy

    Configuration parameters used for performing automatic OS Upgrade.

    Optional automaticOSUpgrade

    automaticOSUpgrade: undefined | false | true

    Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.

    Optional mode

    Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    Automatic - All virtual machines in the scale set are automatically updated at the same time. Possible values include: 'Automatic', 'Manual', 'Rolling'

    Optional rollingUpgradePolicy

    rollingUpgradePolicy: RollingUpgradePolicy

    The configuration parameters used while performing a rolling upgrade.

    serializedName

    serializedName: string = "UpgradePolicy"

    type

    type: object

    className

    className: string = "UpgradePolicy"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    autoOSUpgradePolicy

    autoOSUpgradePolicy: object

    serializedName

    serializedName: string = "autoOSUpgradePolicy"

    type

    type: object

    className

    className: string = "AutoOSUpgradePolicy"

    name

    name: "Composite" = "Composite"

    automaticOSUpgrade

    automaticOSUpgrade: object

    serializedName

    serializedName: string = "automaticOSUpgrade"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    mode

    mode: object

    serializedName

    serializedName: string = "mode"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Automatic","Manual","Rolling"]

    name

    name: "Enum" = "Enum"

    rollingUpgradePolicy

    rollingUpgradePolicy: object

    serializedName

    serializedName: string = "rollingUpgradePolicy"

    type

    type: object

    className

    className: string = "RollingUpgradePolicy"

    name

    name: "Composite" = "Composite"

    Const Usage

    Usage: object

    Describes Compute Resource Usage.

    currentValue

    currentValue: number

    The current usage of the resource.

    limit

    limit: number

    The maximum permitted usage of the resource.

    name

    name: UsageName

    The name of the type of usage.

    serializedName

    serializedName: string = "Usage"

    type

    type: object

    className

    className: string = "Usage"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    currentValue

    currentValue: object

    required

    required: true = true

    serializedName

    serializedName: string = "currentValue"

    type

    type: object

    name

    name: "Number" = "Number"

    limit

    limit: object

    required

    required: true = true

    serializedName

    serializedName: string = "limit"

    type

    type: object

    name

    name: "Number" = "Number"

    name

    name: object

    required

    required: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    className

    className: string = "UsageName"

    name

    name: "Composite" = "Composite"

    unit

    unit: object

    defaultValue

    defaultValue: string = "Count"

    isConstant

    isConstant: true = true

    required

    required: true = true

    serializedName

    serializedName: string = "unit"

    type

    type: object

    name

    name: "String" = "String"

    Const UsageName

    UsageName: object

    The Usage Names.

    Optional localizedValue

    localizedValue: undefined | string

    The localized name of the resource.

    Optional value

    value: undefined | string

    The name of the resource.

    serializedName

    serializedName: string = "UsageName"

    type

    type: object

    className

    className: string = "UsageName"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    localizedValue

    localizedValue: object

    serializedName

    serializedName: string = "localizedValue"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    serializedName

    serializedName: string = "value"

    type

    type: object

    name

    name: "String" = "String"

    Const VaultCertificate

    VaultCertificate: object

    Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

    Optional certificateStore

    certificateStore: undefined | string

    For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

    For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.

    Optional certificateUrl

    certificateUrl: undefined | string

    This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

    {
    "data":"",
    "dataType":"pfx",
    "password":""
    }

    serializedName

    serializedName: string = "VaultCertificate"

    type

    type: object

    className

    className: string = "VaultCertificate"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    certificateStore

    certificateStore: object

    serializedName

    serializedName: string = "certificateStore"

    type

    type: object

    name

    name: "String" = "String"

    certificateUrl

    certificateUrl: object

    serializedName

    serializedName: string = "certificateUrl"

    type

    type: object

    name

    name: "String" = "String"

    Const VaultSecretGroup

    VaultSecretGroup: object

    Describes a set of certificates which are all in the same Key Vault.

    Optional sourceVault

    sourceVault: SubResource

    The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

    Optional vaultCertificates

    vaultCertificates: VaultCertificate[]

    The list of key vault references in SourceVault which contain certificates.

    serializedName

    serializedName: string = "VaultSecretGroup"

    type

    type: object

    className

    className: string = "VaultSecretGroup"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    sourceVault

    sourceVault: object

    serializedName

    serializedName: string = "sourceVault"

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    vaultCertificates

    vaultCertificates: object

    serializedName

    serializedName: string = "vaultCertificates"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VaultCertificate"

    name

    name: "Composite" = "Composite"

    Const VirtualHardDisk

    VirtualHardDisk: object

    Describes the uri of a disk.

    Optional uri

    uri: undefined | string

    Specifies the virtual hard disk's uri.

    serializedName

    serializedName: string = "VirtualHardDisk"

    type

    type: object

    className

    className: string = "VirtualHardDisk"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    uri

    uri: object

    serializedName

    serializedName: string = "uri"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachine

    VirtualMachine: object

    Describes a Virtual Machine.

    Optional availabilitySet

    availabilitySet: SubResource

    Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines.

    For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

    Optional diagnosticsProfile

    diagnosticsProfile: DiagnosticsProfile

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    Optional hardwareProfile

    hardwareProfile: HardwareProfile

    Specifies the hardware settings for the virtual machine.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    Optional identity

    The identity of the virtual machine, if configured.

    Optional instanceView

    The virtual machine instance view. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional licenseType

    licenseType: undefined | string

    Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see Azure Hybrid Use Benefit for Windows Server

    Minimum api-version: 2015-06-15

    location

    location: string

    Resource location

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    Optional networkProfile

    networkProfile: NetworkProfile

    Specifies the network interfaces of the virtual machine.

    Optional osProfile

    osProfile: OSProfile

    Specifies the operating system settings for the virtual machine.

    Optional plan

    plan: Plan

    Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

    Optional provisioningState

    provisioningState: undefined | string

    The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional resources

    The virtual machine child extension resources. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional storageProfile

    storageProfile: StorageProfile

    Specifies the storage settings for the virtual machine disks.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional vmId

    vmId: undefined | string

    Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional zones

    zones: string[]

    The virtual machine zones.

    serializedName

    serializedName: string = "VirtualMachine"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "VirtualMachine"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    availabilitySet

    availabilitySet: object

    serializedName

    serializedName: string = "properties.availabilitySet"

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    diagnosticsProfile

    diagnosticsProfile: object

    serializedName

    serializedName: string = "properties.diagnosticsProfile"

    type

    type: object

    className

    className: string = "DiagnosticsProfile"

    name

    name: "Composite" = "Composite"

    hardwareProfile

    hardwareProfile: object

    serializedName

    serializedName: string = "properties.hardwareProfile"

    type

    type: object

    className

    className: string = "HardwareProfile"

    name

    name: "Composite" = "Composite"

    identity

    identity: object

    serializedName

    serializedName: string = "identity"

    type

    type: object

    className

    className: string = "VirtualMachineIdentity"

    name

    name: "Composite" = "Composite"

    instanceView

    instanceView: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.instanceView"

    type

    type: object

    className

    className: string = "VirtualMachineInstanceView"

    name

    name: "Composite" = "Composite"

    licenseType

    licenseType: object

    serializedName

    serializedName: string = "properties.licenseType"

    type

    type: object

    name

    name: "String" = "String"

    networkProfile

    networkProfile: object

    serializedName

    serializedName: string = "properties.networkProfile"

    type

    type: object

    className

    className: string = "NetworkProfile"

    name

    name: "Composite" = "Composite"

    osProfile

    osProfile: object

    serializedName

    serializedName: string = "properties.osProfile"

    type

    type: object

    className

    className: string = "OSProfile"

    name

    name: "Composite" = "Composite"

    plan

    plan: object

    serializedName

    serializedName: string = "plan"

    type

    type: object

    className

    className: string = "Plan"

    name

    name: "Composite" = "Composite"

    provisioningState

    provisioningState: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.provisioningState"

    type

    type: object

    name

    name: "String" = "String"

    resources

    resources: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "resources"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineExtension"

    name

    name: "Composite" = "Composite"

    storageProfile

    storageProfile: object

    serializedName

    serializedName: string = "properties.storageProfile"

    type

    type: object

    className

    className: string = "StorageProfile"

    name

    name: "Composite" = "Composite"

    vmId

    vmId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.vmId"

    type

    type: object

    name

    name: "String" = "String"

    zones

    zones: object

    serializedName

    serializedName: string = "zones"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineAgentInstanceView

    VirtualMachineAgentInstanceView: object

    The instance view of the VM Agent running on the virtual machine.

    Optional extensionHandlers

    The virtual machine extension handler instance view.

    Optional statuses

    statuses: InstanceViewStatus[]

    The resource status information.

    Optional vmAgentVersion

    vmAgentVersion: undefined | string

    The VM Agent full version.

    serializedName

    serializedName: string = "VirtualMachineAgentInstanceView"

    type

    type: object

    className

    className: string = "VirtualMachineAgentInstanceView"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    extensionHandlers

    extensionHandlers: object

    serializedName

    serializedName: string = "extensionHandlers"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineExtensionHandlerInstanceView"

    name

    name: "Composite" = "Composite"

    statuses

    statuses: object

    serializedName

    serializedName: string = "statuses"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    vmAgentVersion

    vmAgentVersion: object

    serializedName

    serializedName: string = "vmAgentVersion"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineCaptureParameters

    VirtualMachineCaptureParameters: object

    Capture Virtual Machine parameters.

    destinationContainerName

    destinationContainerName: string

    The destination container name.

    overwriteVhds

    overwriteVhds: boolean

    Specifies whether to overwrite the destination virtual hard disk, in case of conflict.

    vhdPrefix

    vhdPrefix: string

    The captured virtual hard disk's name prefix.

    serializedName

    serializedName: string = "VirtualMachineCaptureParameters"

    type

    type: object

    className

    className: string = "VirtualMachineCaptureParameters"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    destinationContainerName

    destinationContainerName: object

    required

    required: true = true

    serializedName

    serializedName: string = "destinationContainerName"

    type

    type: object

    name

    name: "String" = "String"

    overwriteVhds

    overwriteVhds: object

    required

    required: true = true

    serializedName

    serializedName: string = "overwriteVhds"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    vhdPrefix

    vhdPrefix: object

    required

    required: true = true

    serializedName

    serializedName: string = "vhdPrefix"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineCaptureResult

    VirtualMachineCaptureResult: object

    Resource Id.

    Optional id

    id: undefined | string

    Resource Id

    Optional output

    output: any

    Operation output data (raw JSON)

    serializedName

    serializedName: string = "VirtualMachineCaptureResult"

    type

    type: object

    className

    className: string = "VirtualMachineCaptureResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    output

    output: object

    serializedName

    serializedName: string = "properties.output"

    type

    type: object

    name

    name: "Object" = "Object"

    Const VirtualMachineExtension

    VirtualMachineExtension: object

    Describes a Virtual Machine Extension.

    Optional autoUpgradeMinorVersion

    autoUpgradeMinorVersion: undefined | false | true

    Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

    Optional forceUpdateTag

    forceUpdateTag: undefined | string

    How the extension handler should be forced to update even if the extension configuration has not changed.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    Optional instanceView

    The virtual machine extension instance view.

    location

    location: string

    Resource location

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    Optional protectedSettings

    protectedSettings: any

    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

    Optional provisioningState

    provisioningState: undefined | string

    The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional publisher

    publisher: undefined | string

    The name of the extension handler publisher.

    Optional settings

    settings: any

    Json formatted public settings for the extension.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional typeHandlerVersion

    typeHandlerVersion: undefined | string

    Specifies the version of the script handler.

    Optional virtualMachineExtensionType

    virtualMachineExtensionType: undefined | string

    Specifies the type of the extension; an example is "CustomScriptExtension".

    serializedName

    serializedName: string = "VirtualMachineExtension"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "VirtualMachineExtension"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    autoUpgradeMinorVersion

    autoUpgradeMinorVersion: object

    serializedName

    serializedName: string = "properties.autoUpgradeMinorVersion"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    forceUpdateTag

    forceUpdateTag: object

    serializedName

    serializedName: string = "properties.forceUpdateTag"

    type

    type: object

    name

    name: "String" = "String"

    instanceView

    instanceView: object

    serializedName

    serializedName: string = "properties.instanceView"

    type

    type: object

    className

    className: string = "VirtualMachineExtensionInstanceView"

    name

    name: "Composite" = "Composite"

    protectedSettings

    protectedSettings: object

    serializedName

    serializedName: string = "properties.protectedSettings"

    type

    type: object

    name

    name: "Object" = "Object"

    provisioningState

    provisioningState: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.provisioningState"

    type

    type: object

    name

    name: "String" = "String"

    publisher

    publisher: object

    serializedName

    serializedName: string = "properties.publisher"

    type

    type: object

    name

    name: "String" = "String"

    settings

    settings: object

    serializedName

    serializedName: string = "properties.settings"

    type

    type: object

    name

    name: "Object" = "Object"

    typeHandlerVersion

    typeHandlerVersion: object

    serializedName

    serializedName: string = "properties.typeHandlerVersion"

    type

    type: object

    name

    name: "String" = "String"

    virtualMachineExtensionType

    virtualMachineExtensionType: object

    serializedName

    serializedName: string = "properties.type"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineExtensionHandlerInstanceView

    VirtualMachineExtensionHandlerInstanceView: object

    The instance view of a virtual machine extension handler.

    Optional status

    The extension handler status.

    Optional typeHandlerVersion

    typeHandlerVersion: undefined | string

    Specifies the version of the script handler.

    serializedName

    serializedName: string = "VirtualMachineExtensionHandlerInstanceView"

    Optional type

    type: object

    Specifies the type of the extension; an example is "CustomScriptExtension".

    className

    className: string = "VirtualMachineExtensionHandlerInstanceView"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    status

    status: object

    serializedName

    serializedName: string = "status"

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    type

    type: object

    serializedName

    serializedName: string = "type"

    type

    type: object

    name

    name: "String" = "String"

    typeHandlerVersion

    typeHandlerVersion: object

    serializedName

    serializedName: string = "typeHandlerVersion"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineExtensionImage

    VirtualMachineExtensionImage: object

    Describes a Virtual Machine Extension Image.

    computeRole

    computeRole: string

    The type of role (IaaS or PaaS) this extension supports.

    handlerSchema

    handlerSchema: string

    The schema defined by publisher, where extension consumers should provide settings in a matching schema.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    location

    location: string

    Resource location

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    operatingSystem

    operatingSystem: string

    The operating system this extension supports.

    Optional supportsMultipleExtensions

    supportsMultipleExtensions: undefined | false | true

    Whether the handler can support multiple extensions.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional vmScaleSetEnabled

    vmScaleSetEnabled: undefined | false | true

    Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.

    serializedName

    serializedName: string = "VirtualMachineExtensionImage"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "VirtualMachineExtensionImage"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    computeRole

    computeRole: object

    required

    required: true = true

    serializedName

    serializedName: string = "properties.computeRole"

    type

    type: object

    name

    name: "String" = "String"

    handlerSchema

    handlerSchema: object

    required

    required: true = true

    serializedName

    serializedName: string = "properties.handlerSchema"

    type

    type: object

    name

    name: "String" = "String"

    operatingSystem

    operatingSystem: object

    required

    required: true = true

    serializedName

    serializedName: string = "properties.operatingSystem"

    type

    type: object

    name

    name: "String" = "String"

    supportsMultipleExtensions

    supportsMultipleExtensions: object

    serializedName

    serializedName: string = "properties.supportsMultipleExtensions"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    vmScaleSetEnabled

    vmScaleSetEnabled: object

    serializedName

    serializedName: string = "properties.vmScaleSetEnabled"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    Const VirtualMachineExtensionInstanceView

    VirtualMachineExtensionInstanceView: object

    The instance view of a virtual machine extension.

    Optional name

    name: undefined | string

    The virtual machine extension name.

    Optional statuses

    statuses: InstanceViewStatus[]

    The resource status information.

    Optional substatuses

    substatuses: InstanceViewStatus[]

    The resource status information.

    Optional typeHandlerVersion

    typeHandlerVersion: undefined | string

    Specifies the version of the script handler.

    serializedName

    serializedName: string = "VirtualMachineExtensionInstanceView"

    Optional type

    type: object

    Specifies the type of the extension; an example is "CustomScriptExtension".

    className

    className: string = "VirtualMachineExtensionInstanceView"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    statuses

    statuses: object

    serializedName

    serializedName: string = "statuses"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    substatuses

    substatuses: object

    serializedName

    serializedName: string = "substatuses"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    type

    type: object

    serializedName

    serializedName: string = "type"

    type

    type: object

    name

    name: "String" = "String"

    typeHandlerVersion

    typeHandlerVersion: object

    serializedName

    serializedName: string = "typeHandlerVersion"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineExtensionUpdate

    VirtualMachineExtensionUpdate: object

    Describes a Virtual Machine Extension.

    Optional autoUpgradeMinorVersion

    autoUpgradeMinorVersion: undefined | false | true

    Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

    Optional forceUpdateTag

    forceUpdateTag: undefined | string

    How the extension handler should be forced to update even if the extension configuration has not changed.

    Optional protectedSettings

    protectedSettings: any

    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

    Optional publisher

    publisher: undefined | string

    The name of the extension handler publisher.

    Optional settings

    settings: any

    Json formatted public settings for the extension.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional typeHandlerVersion

    typeHandlerVersion: undefined | string

    Specifies the version of the script handler.

    serializedName

    serializedName: string = "VirtualMachineExtensionUpdate"

    Optional type

    type: object

    Specifies the type of the extension; an example is "CustomScriptExtension".

    className

    className: string = "VirtualMachineExtensionUpdate"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    autoUpgradeMinorVersion

    autoUpgradeMinorVersion: object

    serializedName

    serializedName: string = "properties.autoUpgradeMinorVersion"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    forceUpdateTag

    forceUpdateTag: object

    serializedName

    serializedName: string = "properties.forceUpdateTag"

    type

    type: object

    name

    name: "String" = "String"

    protectedSettings

    protectedSettings: object

    serializedName

    serializedName: string = "properties.protectedSettings"

    type

    type: object

    name

    name: "Object" = "Object"

    publisher

    publisher: object

    serializedName

    serializedName: string = "properties.publisher"

    type

    type: object

    name

    name: "String" = "String"

    settings

    settings: object

    serializedName

    serializedName: string = "properties.settings"

    type

    type: object

    name

    name: "Object" = "Object"

    type

    type: object

    serializedName

    serializedName: string = "properties.type"

    type

    type: object

    name

    name: "String" = "String"

    typeHandlerVersion

    typeHandlerVersion: object

    serializedName

    serializedName: string = "properties.typeHandlerVersion"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineExtensionsListResult

    VirtualMachineExtensionsListResult: object

    The List Extension operation response

    Optional value

    The list of extensions

    serializedName

    serializedName: string = "VirtualMachineExtensionsListResult"

    type

    type: object

    className

    className: string = "VirtualMachineExtensionsListResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    value

    value: object

    serializedName

    serializedName: string = "value"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineExtension"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineHealthStatus

    VirtualMachineHealthStatus: object

    The health status of the VM.

    Optional status

    The health status information for the VM. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineHealthStatus"

    type

    type: object

    className

    className: string = "VirtualMachineHealthStatus"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    status

    status: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "status"

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineIdentity

    VirtualMachineIdentity: object

    Identity for the virtual machine.

    Optional identityIds

    identityIds: string[]

    The list of user identities associated with the Virtual Machine. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'.

    Optional principalId

    principalId: undefined | string

    The principal id of virtual machine identity. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional tenantId

    tenantId: undefined | string

    The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineIdentity"

    Optional type

    type: object

    The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    className

    className: string = "VirtualMachineIdentity"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    identityIds

    identityIds: object

    serializedName

    serializedName: string = "identityIds"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    principalId

    principalId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "principalId"

    type

    type: object

    name

    name: "String" = "String"

    tenantId

    tenantId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "tenantId"

    type

    type: object

    name

    name: "String" = "String"

    type

    type: object

    serializedName

    serializedName: string = "type"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["SystemAssigned","UserAssigned","SystemAssigned, UserAssigned","None"]

    name

    name: "Enum" = "Enum"

    Const VirtualMachineImage

    VirtualMachineImage: object

    Describes a Virtual Machine Image.

    Optional dataDiskImages

    dataDiskImages: DataDiskImage[]

    Optional id

    id: undefined | string

    Resource Id

    location

    location: string

    The supported Azure location of the resource.

    name

    name: string

    The name of the resource.

    Optional osDiskImage

    osDiskImage: OSDiskImage

    Optional plan

    Optional tags

    tags: undefined | object

    Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.

    serializedName

    serializedName: string = "VirtualMachineImage"

    type

    type: object

    className

    className: string = "VirtualMachineImage"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dataDiskImages

    dataDiskImages: object

    serializedName

    serializedName: string = "properties.dataDiskImages"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "DataDiskImage"

    name

    name: "Composite" = "Composite"

    osDiskImage

    osDiskImage: object

    serializedName

    serializedName: string = "properties.osDiskImage"

    type

    type: object

    className

    className: string = "OSDiskImage"

    name

    name: "Composite" = "Composite"

    plan

    plan: object

    serializedName

    serializedName: string = "properties.plan"

    type

    type: object

    className

    className: string = "PurchasePlan"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineImageResource

    VirtualMachineImageResource: object

    Virtual machine image resource information.

    Optional id

    id: undefined | string

    Resource Id

    location

    location: string

    The supported Azure location of the resource.

    name

    name: string

    The name of the resource.

    Optional tags

    tags: undefined | object

    Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.

    serializedName

    serializedName: string = "VirtualMachineImageResource"

    type

    type: object

    className

    className: string = "VirtualMachineImageResource"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    location

    location: object

    required

    required: true = true

    serializedName

    serializedName: string = "location"

    type

    type: object

    name

    name: "String" = "String"

    name

    name: object

    required

    required: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    tags

    tags: object

    serializedName

    serializedName: string = "tags"

    type

    type: object

    name

    name: "Dictionary" = "Dictionary"

    value

    value: object

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineInstanceView

    VirtualMachineInstanceView: object

    The instance view of a virtual machine.

    Optional bootDiagnostics

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.

    Optional computerName

    computerName: undefined | string

    The computer name assigned to the virtual machine.

    Optional disks

    The virtual machine disk information.

    Optional extensions

    The extensions information.

    Optional maintenanceRedeployStatus

    maintenanceRedeployStatus: MaintenanceRedeployStatus

    The Maintenance Operation status on the virtual machine.

    Optional osName

    osName: undefined | string

    The Operating System running on the virtual machine.

    Optional osVersion

    osVersion: undefined | string

    The version of Operating System running on the virtual machine.

    Optional platformFaultDomain

    platformFaultDomain: undefined | number

    Specifies the fault domain of the virtual machine.

    Optional platformUpdateDomain

    platformUpdateDomain: undefined | number

    Specifies the update domain of the virtual machine.

    Optional rdpThumbPrint

    rdpThumbPrint: undefined | string

    The Remote desktop certificate thumbprint.

    Optional statuses

    statuses: InstanceViewStatus[]

    The resource status information.

    Optional vmAgent

    The VM Agent running on the virtual machine.

    serializedName

    serializedName: string = "VirtualMachineInstanceView"

    type

    type: object

    className

    className: string = "VirtualMachineInstanceView"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    bootDiagnostics

    bootDiagnostics: object

    serializedName

    serializedName: string = "bootDiagnostics"

    type

    type: object

    className

    className: string = "BootDiagnosticsInstanceView"

    name

    name: "Composite" = "Composite"

    computerName

    computerName: object

    serializedName

    serializedName: string = "computerName"

    type

    type: object

    name

    name: "String" = "String"

    disks

    disks: object

    serializedName

    serializedName: string = "disks"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "DiskInstanceView"

    name

    name: "Composite" = "Composite"

    extensions

    extensions: object

    serializedName

    serializedName: string = "extensions"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineExtensionInstanceView"

    name

    name: "Composite" = "Composite"

    maintenanceRedeployStatus

    maintenanceRedeployStatus: object

    serializedName

    serializedName: string = "maintenanceRedeployStatus"

    type

    type: object

    className

    className: string = "MaintenanceRedeployStatus"

    name

    name: "Composite" = "Composite"

    osName

    osName: object

    serializedName

    serializedName: string = "osName"

    type

    type: object

    name

    name: "String" = "String"

    osVersion

    osVersion: object

    serializedName

    serializedName: string = "osVersion"

    type

    type: object

    name

    name: "String" = "String"

    platformFaultDomain

    platformFaultDomain: object

    serializedName

    serializedName: string = "platformFaultDomain"

    type

    type: object

    name

    name: "Number" = "Number"

    platformUpdateDomain

    platformUpdateDomain: object

    serializedName

    serializedName: string = "platformUpdateDomain"

    type

    type: object

    name

    name: "Number" = "Number"

    rdpThumbPrint

    rdpThumbPrint: object

    serializedName

    serializedName: string = "rdpThumbPrint"

    type

    type: object

    name

    name: "String" = "String"

    statuses

    statuses: object

    serializedName

    serializedName: string = "statuses"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    vmAgent

    vmAgent: object

    serializedName

    serializedName: string = "vmAgent"

    type

    type: object

    className

    className: string = "VirtualMachineAgentInstanceView"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineListResult

    VirtualMachineListResult: object
    interface

    The List Virtual Machine operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.

    serializedName

    serializedName: string = "VirtualMachineListResult"

    __@iterator

    • Iterator

      Returns IterableIterator<VirtualMachine>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      • Rest ...items: ConcatArray<VirtualMachine>[]

        Additional items to add to the end of array1.

      Returns VirtualMachine[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns VirtualMachine[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, VirtualMachine]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    fill

    • fill(value: VirtualMachine, start?: undefined | number, end?: undefined | number): this
    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: VirtualMachine

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter<S>(callbackfn: function, thisArg?: any): S[]
    • filter(callbackfn: function, thisArg?: any): VirtualMachine[]
    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns VirtualMachine[]

    find

    • find<S>(predicate: function, thisArg?: any): S | undefined
    • find(predicate: function, thisArg?: any): VirtualMachine | undefined
    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type parameters

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns S | undefined

    • Parameters

      Returns VirtualMachine | undefined

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    includes

    • includes(searchElement: VirtualMachine, fromIndex?: undefined | number): boolean
    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: VirtualMachine

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement: VirtualMachine, fromIndex?: undefined | number): number
    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: VirtualMachine

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • lastIndexOf(searchElement: VirtualMachine, fromIndex?: undefined | number): number
    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: VirtualMachine

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns VirtualMachine | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      Returns VirtualMachine

    • Parameters

      Returns VirtualMachine

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    reduceRight

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      Returns VirtualMachine

    • Parameters

      Returns VirtualMachine

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    reverse

    • Reverses the elements in an Array.

      Returns VirtualMachine[]

    shift

    • Removes the first element from an array and returns it.

      Returns VirtualMachine | undefined

    slice

    • slice(start?: undefined | number, end?: undefined | number): VirtualMachine[]
    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns VirtualMachine[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns VirtualMachine[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: VirtualMachine[]

        Elements to insert into the array in place of the deleted elements.

      Returns VirtualMachine[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      • Rest ...items: VirtualMachine[]

        Elements to insert at the start of the Array.

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<VirtualMachine>

    type

    type: object

    className

    className: string = "VirtualMachineListResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachine"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSet

    VirtualMachineScaleSet: object

    Describes a Virtual Machine Scale Set.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    Optional identity

    The identity of the virtual machine scale set, if configured.

    location

    location: string

    Resource location

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    Optional overprovision

    overprovision: undefined | false | true

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    Optional plan

    plan: Plan

    Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

    Optional platformFaultDomainCount

    platformFaultDomainCount: undefined | number

    Fault Domain count for each placement group.

    Optional provisioningState

    provisioningState: undefined | string

    The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional singlePlacementGroup

    singlePlacementGroup: undefined | false | true

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    Optional sku

    sku: Sku

    The virtual machine scale set sku.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional uniqueId

    uniqueId: undefined | string

    Specifies the ID which uniquely identifies a Virtual Machine Scale Set. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional upgradePolicy

    upgradePolicy: UpgradePolicy

    The upgrade policy.

    Optional virtualMachineProfile

    virtualMachineProfile: VirtualMachineScaleSetVMProfile

    The virtual machine profile.

    Optional zoneBalance

    zoneBalance: undefined | false | true

    Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    Optional zones

    zones: string[]

    The virtual machine scale set zones.

    serializedName

    serializedName: string = "VirtualMachineScaleSet"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "VirtualMachineScaleSet"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    identity

    identity: object

    serializedName

    serializedName: string = "identity"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetIdentity"

    name

    name: "Composite" = "Composite"

    overprovision

    overprovision: object

    serializedName

    serializedName: string = "properties.overprovision"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    plan

    plan: object

    serializedName

    serializedName: string = "plan"

    type

    type: object

    className

    className: string = "Plan"

    name

    name: "Composite" = "Composite"

    platformFaultDomainCount

    platformFaultDomainCount: object

    serializedName

    serializedName: string = "properties.platformFaultDomainCount"

    type

    type: object

    name

    name: "Number" = "Number"

    provisioningState

    provisioningState: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.provisioningState"

    type

    type: object

    name

    name: "String" = "String"

    singlePlacementGroup

    singlePlacementGroup: object

    serializedName

    serializedName: string = "properties.singlePlacementGroup"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    sku

    sku: object

    serializedName

    serializedName: string = "sku"

    type

    type: object

    className

    className: string = "Sku"

    name

    name: "Composite" = "Composite"

    uniqueId

    uniqueId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.uniqueId"

    type

    type: object

    name

    name: "String" = "String"

    upgradePolicy

    upgradePolicy: object

    serializedName

    serializedName: string = "properties.upgradePolicy"

    type

    type: object

    className

    className: string = "UpgradePolicy"

    name

    name: "Composite" = "Composite"

    virtualMachineProfile

    virtualMachineProfile: object

    serializedName

    serializedName: string = "properties.virtualMachineProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMProfile"

    name

    name: "Composite" = "Composite"

    zoneBalance

    zoneBalance: object

    serializedName

    serializedName: string = "properties.zoneBalance"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    zones

    zones: object

    serializedName

    serializedName: string = "zones"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetDataDisk

    VirtualMachineScaleSetDataDisk: object

    Describes a virtual machine scale set data disk.

    Optional caching

    caching: CachingTypes

    Specifies the caching requirements.

    Possible values are:

    None

    ReadOnly

    ReadWrite

    Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    createOption

    createOption: DiskCreateOptionTypes

    The create option. Possible values include: 'FromImage', 'Empty', 'Attach'

    Optional diskSizeGB

    diskSizeGB: undefined | number

    Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB

    lun

    lun: number

    Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

    Optional managedDisk

    The managed disk parameters.

    Optional name

    name: undefined | string

    The disk name.

    Optional writeAcceleratorEnabled

    writeAcceleratorEnabled: undefined | false | true

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    serializedName

    serializedName: string = "VirtualMachineScaleSetDataDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetDataDisk"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    caching

    caching: object

    serializedName

    serializedName: string = "caching"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["None","ReadOnly","ReadWrite"]

    name

    name: "Enum" = "Enum"

    createOption

    createOption: object

    required

    required: true = true

    serializedName

    serializedName: string = "createOption"

    type

    type: object

    name

    name: "String" = "String"

    diskSizeGB

    diskSizeGB: object

    serializedName

    serializedName: string = "diskSizeGB"

    type

    type: object

    name

    name: "Number" = "Number"

    lun

    lun: object

    required

    required: true = true

    serializedName

    serializedName: string = "lun"

    type

    type: object

    name

    name: "Number" = "Number"

    managedDisk

    managedDisk: object

    serializedName

    serializedName: string = "managedDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetManagedDiskParameters"

    name

    name: "Composite" = "Composite"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    writeAcceleratorEnabled

    writeAcceleratorEnabled: object

    serializedName

    serializedName: string = "writeAcceleratorEnabled"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    Const VirtualMachineScaleSetExtension

    VirtualMachineScaleSetExtension: object

    Describes a Virtual Machine Scale Set Extension.

    Optional autoUpgradeMinorVersion

    autoUpgradeMinorVersion: undefined | false | true

    Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

    Optional forceUpdateTag

    forceUpdateTag: undefined | string

    If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    Optional name

    name: undefined | string

    The name of the extension.

    Optional protectedSettings

    protectedSettings: any

    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

    Optional provisioningState

    provisioningState: undefined | string

    The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional publisher

    publisher: undefined | string

    The name of the extension handler publisher.

    Optional settings

    settings: any

    Json formatted public settings for the extension.

    Optional typeHandlerVersion

    typeHandlerVersion: undefined | string

    Specifies the version of the script handler.

    serializedName

    serializedName: string = "VirtualMachineScaleSetExtension"

    Optional type

    type: object

    Specifies the type of the extension; an example is "CustomScriptExtension".

    className

    className: string = "VirtualMachineScaleSetExtension"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    autoUpgradeMinorVersion

    autoUpgradeMinorVersion: object

    serializedName

    serializedName: string = "properties.autoUpgradeMinorVersion"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    forceUpdateTag

    forceUpdateTag: object

    serializedName

    serializedName: string = "properties.forceUpdateTag"

    type

    type: object

    name

    name: "String" = "String"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    protectedSettings

    protectedSettings: object

    serializedName

    serializedName: string = "properties.protectedSettings"

    type

    type: object

    name

    name: "Object" = "Object"

    provisioningState

    provisioningState: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.provisioningState"

    type

    type: object

    name

    name: "String" = "String"

    publisher

    publisher: object

    serializedName

    serializedName: string = "properties.publisher"

    type

    type: object

    name

    name: "String" = "String"

    settings

    settings: object

    serializedName

    serializedName: string = "properties.settings"

    type

    type: object

    name

    name: "Object" = "Object"

    type

    type: object

    serializedName

    serializedName: string = "properties.type"

    type

    type: object

    name

    name: "String" = "String"

    typeHandlerVersion

    typeHandlerVersion: object

    serializedName

    serializedName: string = "properties.typeHandlerVersion"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetExtensionListResult

    VirtualMachineScaleSetExtensionListResult: object
    interface

    The List VM scale set extension operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions.

    serializedName

    serializedName: string = "VirtualMachineScaleSetExtensionListResult"

    __@iterator

    • Iterator

      Returns IterableIterator<VirtualMachineScaleSetExtension>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      Returns VirtualMachineScaleSetExtension[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns VirtualMachineScaleSetExtension[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, VirtualMachineScaleSetExtension]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      Returns boolean

    fill

    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: VirtualMachineScaleSetExtension

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      Returns VirtualMachineScaleSetExtension[]

    find

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: VirtualMachineScaleSetExtension

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSetExtension

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSetExtension

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns VirtualMachineScaleSetExtension | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    reduceRight

    reverse

    • Reverses the elements in an Array.

      Returns VirtualMachineScaleSetExtension[]

    shift

    • Removes the first element from an array and returns it.

      Returns VirtualMachineScaleSetExtension | undefined

    slice

    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns VirtualMachineScaleSetExtension[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns VirtualMachineScaleSetExtension[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: VirtualMachineScaleSetExtension[]

        Elements to insert into the array in place of the deleted elements.

      Returns VirtualMachineScaleSetExtension[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<VirtualMachineScaleSetExtension>

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetExtensionListResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetExtension"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetExtensionProfile

    VirtualMachineScaleSetExtensionProfile: object

    Describes a virtual machine scale set extension profile.

    Optional extensions

    The virtual machine scale set child extension resources.

    serializedName

    serializedName: string = "VirtualMachineScaleSetExtensionProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetExtensionProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    extensions

    extensions: object

    serializedName

    serializedName: string = "extensions"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetExtension"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetIPConfiguration

    VirtualMachineScaleSetIPConfiguration: object

    Describes a virtual machine scale set network profile's IP configuration.

    Optional applicationGatewayBackendAddressPools

    applicationGatewayBackendAddressPools: SubResource[]

    Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.

    Optional id

    id: undefined | string

    Resource Id

    Optional loadBalancerBackendAddressPools

    loadBalancerBackendAddressPools: SubResource[]

    Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.

    Optional loadBalancerInboundNatPools

    loadBalancerInboundNatPools: SubResource[]

    Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer

    name

    name: string

    The IP configuration name.

    Optional primary

    primary: undefined | false | true

    Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    Optional privateIPAddressVersion

    privateIPAddressVersion: IPVersion

    Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6'

    Optional publicIPAddressConfiguration

    The publicIPAddressConfiguration.

    Optional subnet

    Specifies the identifier of the subnet.

    serializedName

    serializedName: string = "VirtualMachineScaleSetIPConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetIPConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    applicationGatewayBackendAddressPools

    applicationGatewayBackendAddressPools: object

    serializedName

    serializedName: string = "properties.applicationGatewayBackendAddressPools"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    loadBalancerBackendAddressPools

    loadBalancerBackendAddressPools: object

    serializedName

    serializedName: string = "properties.loadBalancerBackendAddressPools"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    loadBalancerInboundNatPools

    loadBalancerInboundNatPools: object

    serializedName

    serializedName: string = "properties.loadBalancerInboundNatPools"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    name

    name: object

    required

    required: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    primary

    primary: object

    serializedName

    serializedName: string = "properties.primary"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    privateIPAddressVersion

    privateIPAddressVersion: object

    serializedName

    serializedName: string = "properties.privateIPAddressVersion"

    type

    type: object

    name

    name: "String" = "String"

    publicIPAddressConfiguration

    publicIPAddressConfiguration: object

    serializedName

    serializedName: string = "properties.publicIPAddressConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetPublicIPAddressConfiguration"

    name

    name: "Composite" = "Composite"

    subnet

    subnet: object

    serializedName

    serializedName: string = "properties.subnet"

    type

    type: object

    className

    className: string = "ApiEntityReference"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetIdentity

    VirtualMachineScaleSetIdentity: object

    Identity for the virtual machine scale set.

    Optional identityIds

    identityIds: string[]

    The list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'.

    Optional principalId

    principalId: undefined | string

    The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional tenantId

    tenantId: undefined | string

    The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetIdentity"

    Optional type

    type: object

    The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    className

    className: string = "VirtualMachineScaleSetIdentity"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    identityIds

    identityIds: object

    serializedName

    serializedName: string = "identityIds"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    principalId

    principalId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "principalId"

    type

    type: object

    name

    name: "String" = "String"

    tenantId

    tenantId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "tenantId"

    type

    type: object

    name

    name: "String" = "String"

    type

    type: object

    serializedName

    serializedName: string = "type"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["SystemAssigned","UserAssigned","SystemAssigned, UserAssigned","None"]

    name

    name: "Enum" = "Enum"

    Const VirtualMachineScaleSetInstanceView

    VirtualMachineScaleSetInstanceView: object

    The instance view of a virtual machine scale set.

    Optional extensions

    The extensions information. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional statuses

    statuses: InstanceViewStatus[]

    The resource status information.

    Optional virtualMachine

    The instance view status summary for the virtual machine scale set. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetInstanceView"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetInstanceView"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    extensions

    extensions: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "extensions"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMExtensionsSummary"

    name

    name: "Composite" = "Composite"

    statuses

    statuses: object

    serializedName

    serializedName: string = "statuses"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    virtualMachine

    virtualMachine: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "virtualMachine"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetInstanceViewStatusesSummary"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetInstanceViewStatusesSummary

    VirtualMachineScaleSetInstanceViewStatusesSummary: object

    Instance view statuses summary for virtual machines of a virtual machine scale set.

    Optional statusesSummary

    The extensions information. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetInstanceViewStatusesSummary"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetInstanceViewStatusesSummary"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    statusesSummary

    statusesSummary: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "statusesSummary"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineStatusCodeCount"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetListOSUpgradeHistory

    VirtualMachineScaleSetListOSUpgradeHistory: object
    interface

    List of Virtual Machine Scale Set OS Upgrade History operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.

    serializedName

    serializedName: string = "VirtualMachineScaleSetListOSUpgradeHistory"

    __@iterator

    • Iterator

      Returns IterableIterator<UpgradeOperationHistoricalStatusInfo>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      Returns UpgradeOperationHistoricalStatusInfo[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns UpgradeOperationHistoricalStatusInfo[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, UpgradeOperationHistoricalStatusInfo]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      Returns boolean

    fill

    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: UpgradeOperationHistoricalStatusInfo

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    find

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: UpgradeOperationHistoricalStatusInfo

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: UpgradeOperationHistoricalStatusInfo

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: UpgradeOperationHistoricalStatusInfo

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns UpgradeOperationHistoricalStatusInfo | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    reduceRight

    reverse

    • Reverses the elements in an Array.

      Returns UpgradeOperationHistoricalStatusInfo[]

    shift

    • Removes the first element from an array and returns it.

      Returns UpgradeOperationHistoricalStatusInfo | undefined

    slice

    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns UpgradeOperationHistoricalStatusInfo[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns UpgradeOperationHistoricalStatusInfo[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: UpgradeOperationHistoricalStatusInfo[]

        Elements to insert into the array in place of the deleted elements.

      Returns UpgradeOperationHistoricalStatusInfo[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<UpgradeOperationHistoricalStatusInfo>

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetListOSUpgradeHistory"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "UpgradeOperationHistoricalStatusInfo"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetListResult

    VirtualMachineScaleSetListResult: object
    interface

    The List Virtual Machine operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.

    serializedName

    serializedName: string = "VirtualMachineScaleSetListResult"

    __@iterator

    • Iterator

      Returns IterableIterator<VirtualMachineScaleSet>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      Returns VirtualMachineScaleSet[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns VirtualMachineScaleSet[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, VirtualMachineScaleSet]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    fill

    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: VirtualMachineScaleSet

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter<S>(callbackfn: function, thisArg?: any): S[]
    • filter(callbackfn: function, thisArg?: any): VirtualMachineScaleSet[]
    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns VirtualMachineScaleSet[]

    find

    • find<S>(predicate: function, thisArg?: any): S | undefined
    • find(predicate: function, thisArg?: any): VirtualMachineScaleSet | undefined
    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type parameters

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns S | undefined

    • Parameters

      Returns VirtualMachineScaleSet | undefined

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: VirtualMachineScaleSet

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSet

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSet

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns VirtualMachineScaleSet | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    reduceRight

    reverse

    • Reverses the elements in an Array.

      Returns VirtualMachineScaleSet[]

    shift

    • Removes the first element from an array and returns it.

      Returns VirtualMachineScaleSet | undefined

    slice

    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns VirtualMachineScaleSet[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns VirtualMachineScaleSet[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: VirtualMachineScaleSet[]

        Elements to insert into the array in place of the deleted elements.

      Returns VirtualMachineScaleSet[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<VirtualMachineScaleSet>

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetListResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSet"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetListSkusResult

    VirtualMachineScaleSetListSkusResult: object
    interface

    The Virtual Machine Scale Set List Skus operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus.

    serializedName

    serializedName: string = "VirtualMachineScaleSetListSkusResult"

    __@iterator

    • Iterator

      Returns IterableIterator<VirtualMachineScaleSetSku>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      Returns VirtualMachineScaleSetSku[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns VirtualMachineScaleSetSku[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, VirtualMachineScaleSetSku]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    fill

    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: VirtualMachineScaleSetSku

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter<S>(callbackfn: function, thisArg?: any): S[]
    • filter(callbackfn: function, thisArg?: any): VirtualMachineScaleSetSku[]
    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns VirtualMachineScaleSetSku[]

    find

    • find<S>(predicate: function, thisArg?: any): S | undefined
    • find(predicate: function, thisArg?: any): VirtualMachineScaleSetSku | undefined
    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type parameters

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns S | undefined

    • Parameters

      Returns VirtualMachineScaleSetSku | undefined

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: VirtualMachineScaleSetSku

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSetSku

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSetSku

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns VirtualMachineScaleSetSku | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    reduceRight

    reverse

    • Reverses the elements in an Array.

      Returns VirtualMachineScaleSetSku[]

    shift

    • Removes the first element from an array and returns it.

      Returns VirtualMachineScaleSetSku | undefined

    slice

    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns VirtualMachineScaleSetSku[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns VirtualMachineScaleSetSku[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: VirtualMachineScaleSetSku[]

        Elements to insert into the array in place of the deleted elements.

      Returns VirtualMachineScaleSetSku[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<VirtualMachineScaleSetSku>

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetListSkusResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetSku"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetListWithLinkResult

    VirtualMachineScaleSetListWithLinkResult: object
    interface

    The List Virtual Machine operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets.

    serializedName

    serializedName: string = "VirtualMachineScaleSetListWithLinkResult"

    __@iterator

    • Iterator

      Returns IterableIterator<VirtualMachineScaleSet>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      Returns VirtualMachineScaleSet[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns VirtualMachineScaleSet[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, VirtualMachineScaleSet]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    fill

    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: VirtualMachineScaleSet

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter<S>(callbackfn: function, thisArg?: any): S[]
    • filter(callbackfn: function, thisArg?: any): VirtualMachineScaleSet[]
    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns VirtualMachineScaleSet[]

    find

    • find<S>(predicate: function, thisArg?: any): S | undefined
    • find(predicate: function, thisArg?: any): VirtualMachineScaleSet | undefined
    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type parameters

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns S | undefined

    • Parameters

      Returns VirtualMachineScaleSet | undefined

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: VirtualMachineScaleSet

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSet

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSet

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns VirtualMachineScaleSet | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    reduceRight

    reverse

    • Reverses the elements in an Array.

      Returns VirtualMachineScaleSet[]

    shift

    • Removes the first element from an array and returns it.

      Returns VirtualMachineScaleSet | undefined

    slice

    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns VirtualMachineScaleSet[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns VirtualMachineScaleSet[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: VirtualMachineScaleSet[]

        Elements to insert into the array in place of the deleted elements.

      Returns VirtualMachineScaleSet[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<VirtualMachineScaleSet>

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetListWithLinkResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSet"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetManagedDiskParameters

    VirtualMachineScaleSetManagedDiskParameters: object

    Describes the parameters of a ScaleSet managed disk.

    Optional storageAccountType

    storageAccountType: StorageAccountTypes

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    serializedName

    serializedName: string = "VirtualMachineScaleSetManagedDiskParameters"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetManagedDiskParameters"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    storageAccountType

    storageAccountType: object

    serializedName

    serializedName: string = "storageAccountType"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetNetworkConfiguration

    VirtualMachineScaleSetNetworkConfiguration: object

    Describes a virtual machine scale set network profile's network configurations.

    Optional dnsSettings

    The dns settings to be applied on the network interfaces.

    Optional enableAcceleratedNetworking

    enableAcceleratedNetworking: undefined | false | true

    Specifies whether the network interface is accelerated networking-enabled.

    Optional enableIPForwarding

    enableIPForwarding: undefined | false | true

    Whether IP forwarding enabled on this NIC.

    Optional id

    id: undefined | string

    Resource Id

    ipConfigurations

    Specifies the IP configurations of the network interface.

    name

    name: string

    The network configuration name.

    Optional networkSecurityGroup

    networkSecurityGroup: SubResource

    The network security group.

    Optional primary

    primary: undefined | false | true

    Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    serializedName

    serializedName: string = "VirtualMachineScaleSetNetworkConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetNetworkConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dnsSettings

    dnsSettings: object

    serializedName

    serializedName: string = "properties.dnsSettings"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetNetworkConfigurationDnsSettings"

    name

    name: "Composite" = "Composite"

    enableAcceleratedNetworking

    enableAcceleratedNetworking: object

    serializedName

    serializedName: string = "properties.enableAcceleratedNetworking"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    enableIPForwarding

    enableIPForwarding: object

    serializedName

    serializedName: string = "properties.enableIPForwarding"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    ipConfigurations

    ipConfigurations: object

    required

    required: true = true

    serializedName

    serializedName: string = "properties.ipConfigurations"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetIPConfiguration"

    name

    name: "Composite" = "Composite"

    name

    name: object

    required

    required: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    networkSecurityGroup

    networkSecurityGroup: object

    serializedName

    serializedName: string = "properties.networkSecurityGroup"

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    primary

    primary: object

    serializedName

    serializedName: string = "properties.primary"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    Const VirtualMachineScaleSetNetworkConfigurationDnsSettings

    VirtualMachineScaleSetNetworkConfigurationDnsSettings: object

    Describes a virtual machines scale sets network configuration's DNS settings.

    Optional dnsServers

    dnsServers: string[]

    List of DNS servers IP addresses

    serializedName

    serializedName: string = "VirtualMachineScaleSetNetworkConfigurationDnsSettings"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetNetworkConfigurationDnsSettings"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dnsServers

    dnsServers: object

    serializedName

    serializedName: string = "dnsServers"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetNetworkProfile

    VirtualMachineScaleSetNetworkProfile: object

    Describes a virtual machine scale set network profile.

    Optional healthProbe

    healthProbe: ApiEntityReference

    A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.

    Optional networkInterfaceConfigurations

    networkInterfaceConfigurations: VirtualMachineScaleSetNetworkConfiguration[]

    The list of network configurations.

    serializedName

    serializedName: string = "VirtualMachineScaleSetNetworkProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetNetworkProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    healthProbe

    healthProbe: object

    serializedName

    serializedName: string = "healthProbe"

    type

    type: object

    className

    className: string = "ApiEntityReference"

    name

    name: "Composite" = "Composite"

    networkInterfaceConfigurations

    networkInterfaceConfigurations: object

    serializedName

    serializedName: string = "networkInterfaceConfigurations"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetNetworkConfiguration"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetOSDisk

    VirtualMachineScaleSetOSDisk: object

    Describes a virtual machine scale set operating system disk.

    Optional caching

    caching: CachingTypes

    Specifies the caching requirements.

    Possible values are:

    None

    ReadOnly

    ReadWrite

    Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    createOption

    createOption: DiskCreateOptionTypes

    Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach'

    Optional image

    Specifies information about the unmanaged user image to base the scale set on.

    Optional managedDisk

    The managed disk parameters.

    Optional name

    name: undefined | string

    The disk name.

    Optional osType

    This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    Windows

    Linux. Possible values include: 'Windows', 'Linux'

    Optional vhdContainers

    vhdContainers: string[]

    Specifies the container urls that are used to store operating system disks for the scale set.

    Optional writeAcceleratorEnabled

    writeAcceleratorEnabled: undefined | false | true

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    serializedName

    serializedName: string = "VirtualMachineScaleSetOSDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetOSDisk"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    caching

    caching: object

    serializedName

    serializedName: string = "caching"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["None","ReadOnly","ReadWrite"]

    name

    name: "Enum" = "Enum"

    createOption

    createOption: object

    required

    required: true = true

    serializedName

    serializedName: string = "createOption"

    type

    type: object

    name

    name: "String" = "String"

    image

    image: object

    serializedName

    serializedName: string = "image"

    type

    type: object

    className

    className: string = "VirtualHardDisk"

    name

    name: "Composite" = "Composite"

    managedDisk

    managedDisk: object

    serializedName

    serializedName: string = "managedDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetManagedDiskParameters"

    name

    name: "Composite" = "Composite"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    osType

    osType: object

    serializedName

    serializedName: string = "osType"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Windows","Linux"]

    name

    name: "Enum" = "Enum"

    vhdContainers

    vhdContainers: object

    serializedName

    serializedName: string = "vhdContainers"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    writeAcceleratorEnabled

    writeAcceleratorEnabled: object

    serializedName

    serializedName: string = "writeAcceleratorEnabled"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    Const VirtualMachineScaleSetOSProfile

    VirtualMachineScaleSetOSProfile: object

    Describes a virtual machine scale set OS profile.

    Optional adminPassword

    adminPassword: undefined | string

    Specifies the password of the administrator account.

    Minimum-length (Windows): 8 characters

    Minimum-length (Linux): 6 characters

    Max-length (Windows): 123 characters

    Max-length (Linux): 72 characters

    Complexity requirements: 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\W_])

    Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM

    For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

    Optional adminUsername

    adminUsername: undefined | string

    Specifies the name of the administrator account.

    Windows-only restriction: Cannot end in "."

    Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

    Minimum-length (Linux): 1 character

    Max-length (Linux): 64 characters

    Max-length (Windows): 20 characters

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • Optional computerNamePrefix

    computerNamePrefix: undefined | string

    Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.

    Optional customData

    customData: undefined | string

    Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    Optional linuxConfiguration

    linuxConfiguration: LinuxConfiguration

    Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions

    For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    Optional secrets

    secrets: VaultSecretGroup[]

    Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    Optional windowsConfiguration

    windowsConfiguration: WindowsConfiguration

    Specifies Windows operating system settings on the virtual machine.

    serializedName

    serializedName: string = "VirtualMachineScaleSetOSProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetOSProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    adminPassword

    adminPassword: object

    serializedName

    serializedName: string = "adminPassword"

    type

    type: object

    name

    name: "String" = "String"

    adminUsername

    adminUsername: object

    serializedName

    serializedName: string = "adminUsername"

    type

    type: object

    name

    name: "String" = "String"

    computerNamePrefix

    computerNamePrefix: object

    serializedName

    serializedName: string = "computerNamePrefix"

    type

    type: object

    name

    name: "String" = "String"

    customData

    customData: object

    serializedName

    serializedName: string = "customData"

    type

    type: object

    name

    name: "String" = "String"

    linuxConfiguration

    linuxConfiguration: object

    serializedName

    serializedName: string = "linuxConfiguration"

    type

    type: object

    className

    className: string = "LinuxConfiguration"

    name

    name: "Composite" = "Composite"

    secrets

    secrets: object

    serializedName

    serializedName: string = "secrets"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VaultSecretGroup"

    name

    name: "Composite" = "Composite"

    windowsConfiguration

    windowsConfiguration: object

    serializedName

    serializedName: string = "windowsConfiguration"

    type

    type: object

    className

    className: string = "WindowsConfiguration"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetPublicIPAddressConfiguration

    VirtualMachineScaleSetPublicIPAddressConfiguration: object

    Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

    Optional dnsSettings

    The dns settings to be applied on the publicIP addresses .

    Optional idleTimeoutInMinutes

    idleTimeoutInMinutes: undefined | number

    The idle timeout of the public IP address.

    name

    name: string

    The publicIP address configuration name.

    serializedName

    serializedName: string = "VirtualMachineScaleSetPublicIPAddressConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetPublicIPAddressConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dnsSettings

    dnsSettings: object

    serializedName

    serializedName: string = "properties.dnsSettings"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings"

    name

    name: "Composite" = "Composite"

    idleTimeoutInMinutes

    idleTimeoutInMinutes: object

    serializedName

    serializedName: string = "properties.idleTimeoutInMinutes"

    type

    type: object

    name

    name: "Number" = "Number"

    name

    name: object

    required

    required: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings: object

    Describes a virtual machines scale sets network configuration's DNS settings.

    domainNameLabel

    domainNameLabel: string

    The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created

    serializedName

    serializedName: string = "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    domainNameLabel

    domainNameLabel: object

    required

    required: true = true

    serializedName

    serializedName: string = "domainNameLabel"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetSku

    VirtualMachineScaleSetSku: object

    Describes an available virtual machine scale set sku.

    Optional capacity

    Specifies the number of virtual machines in the scale set. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional resourceType

    resourceType: undefined | string

    The type of resource the sku applies to. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional sku

    sku: Sku

    The Sku. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetSku"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetSku"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    capacity

    capacity: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "capacity"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetSkuCapacity"

    name

    name: "Composite" = "Composite"

    resourceType

    resourceType: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "resourceType"

    type

    type: object

    name

    name: "String" = "String"

    sku

    sku: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "sku"

    type

    type: object

    className

    className: string = "Sku"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetSkuCapacity

    VirtualMachineScaleSetSkuCapacity: object

    Describes scaling information of a sku.

    Optional defaultCapacity

    defaultCapacity: undefined | number

    The default capacity. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional maximum

    maximum: undefined | number

    The maximum capacity that can be set. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional minimum

    minimum: undefined | number

    The minimum capacity. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional scaleType

    The scale type applicable to the sku. Possible values include: 'Automatic', 'None' NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetSkuCapacity"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetSkuCapacity"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    defaultCapacity

    defaultCapacity: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "defaultCapacity"

    type

    type: object

    name

    name: "Number" = "Number"

    maximum

    maximum: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "maximum"

    type

    type: object

    name

    name: "Number" = "Number"

    minimum

    minimum: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "minimum"

    type

    type: object

    name

    name: "Number" = "Number"

    scaleType

    scaleType: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "scaleType"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Automatic","None"]

    name

    name: "Enum" = "Enum"

    Const VirtualMachineScaleSetStorageProfile

    VirtualMachineScaleSetStorageProfile: object

    Describes a virtual machine scale set storage profile.

    Optional dataDisks

    Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see About disks and VHDs for Azure virtual machines.

    Optional imageReference

    imageReference: ImageReference

    Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.

    Optional osDisk

    Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see About disks and VHDs for Azure virtual machines.

    serializedName

    serializedName: string = "VirtualMachineScaleSetStorageProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetStorageProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dataDisks

    dataDisks: object

    serializedName

    serializedName: string = "dataDisks"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetDataDisk"

    name

    name: "Composite" = "Composite"

    imageReference

    imageReference: object

    serializedName

    serializedName: string = "imageReference"

    type

    type: object

    className

    className: string = "ImageReference"

    name

    name: "Composite" = "Composite"

    osDisk

    osDisk: object

    serializedName

    serializedName: string = "osDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetOSDisk"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetUpdate

    VirtualMachineScaleSetUpdate: object

    Describes a Virtual Machine Scale Set.

    Optional identity

    The identity of the virtual machine scale set, if configured.

    Optional overprovision

    overprovision: undefined | false | true

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    Optional plan

    plan: Plan

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    Optional singlePlacementGroup

    singlePlacementGroup: undefined | false | true

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    Optional sku

    sku: Sku

    The virtual machine scale set sku.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional upgradePolicy

    upgradePolicy: UpgradePolicy

    The upgrade policy.

    Optional virtualMachineProfile

    The virtual machine profile.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdate"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdate"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    identity

    identity: object

    serializedName

    serializedName: string = "identity"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetIdentity"

    name

    name: "Composite" = "Composite"

    overprovision

    overprovision: object

    serializedName

    serializedName: string = "properties.overprovision"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    plan

    plan: object

    serializedName

    serializedName: string = "plan"

    type

    type: object

    className

    className: string = "Plan"

    name

    name: "Composite" = "Composite"

    singlePlacementGroup

    singlePlacementGroup: object

    serializedName

    serializedName: string = "properties.singlePlacementGroup"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    sku

    sku: object

    serializedName

    serializedName: string = "sku"

    type

    type: object

    className

    className: string = "Sku"

    name

    name: "Composite" = "Composite"

    upgradePolicy

    upgradePolicy: object

    serializedName

    serializedName: string = "properties.upgradePolicy"

    type

    type: object

    className

    className: string = "UpgradePolicy"

    name

    name: "Composite" = "Composite"

    virtualMachineProfile

    virtualMachineProfile: object

    serializedName

    serializedName: string = "properties.virtualMachineProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateVMProfile"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetUpdateIPConfiguration

    VirtualMachineScaleSetUpdateIPConfiguration: object

    Describes a virtual machine scale set network profile's IP configuration.

    Optional applicationGatewayBackendAddressPools

    applicationGatewayBackendAddressPools: SubResource[]

    The application gateway backend address pools.

    Optional id

    id: undefined | string

    Resource Id

    Optional loadBalancerBackendAddressPools

    loadBalancerBackendAddressPools: SubResource[]

    The load balancer backend address pools.

    Optional loadBalancerInboundNatPools

    loadBalancerInboundNatPools: SubResource[]

    The load balancer inbound nat pools.

    Optional name

    name: undefined | string

    The IP configuration name.

    Optional primary

    primary: undefined | false | true

    Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.

    Optional privateIPAddressVersion

    privateIPAddressVersion: IPVersion

    Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6'

    Optional publicIPAddressConfiguration

    The publicIPAddressConfiguration.

    Optional subnet

    The subnet.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdateIPConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateIPConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    applicationGatewayBackendAddressPools

    applicationGatewayBackendAddressPools: object

    serializedName

    serializedName: string = "properties.applicationGatewayBackendAddressPools"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    loadBalancerBackendAddressPools

    loadBalancerBackendAddressPools: object

    serializedName

    serializedName: string = "properties.loadBalancerBackendAddressPools"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    loadBalancerInboundNatPools

    loadBalancerInboundNatPools: object

    serializedName

    serializedName: string = "properties.loadBalancerInboundNatPools"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    primary

    primary: object

    serializedName

    serializedName: string = "properties.primary"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    privateIPAddressVersion

    privateIPAddressVersion: object

    serializedName

    serializedName: string = "properties.privateIPAddressVersion"

    type

    type: object

    name

    name: "String" = "String"

    publicIPAddressConfiguration

    publicIPAddressConfiguration: object

    serializedName

    serializedName: string = "properties.publicIPAddressConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration"

    name

    name: "Composite" = "Composite"

    subnet

    subnet: object

    serializedName

    serializedName: string = "properties.subnet"

    type

    type: object

    className

    className: string = "ApiEntityReference"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetUpdateNetworkConfiguration

    VirtualMachineScaleSetUpdateNetworkConfiguration: object

    Describes a virtual machine scale set network profile's network configurations.

    Optional dnsSettings

    The dns settings to be applied on the network interfaces.

    Optional enableAcceleratedNetworking

    enableAcceleratedNetworking: undefined | false | true

    Specifies whether the network interface is accelerated networking-enabled.

    Optional enableIPForwarding

    enableIPForwarding: undefined | false | true

    Whether IP forwarding enabled on this NIC.

    Optional id

    id: undefined | string

    Resource Id

    Optional ipConfigurations

    The virtual machine scale set IP Configuration.

    Optional name

    name: undefined | string

    The network configuration name.

    Optional networkSecurityGroup

    networkSecurityGroup: SubResource

    The network security group.

    Optional primary

    primary: undefined | false | true

    Whether this is a primary NIC on a virtual machine.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdateNetworkConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateNetworkConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dnsSettings

    dnsSettings: object

    serializedName

    serializedName: string = "properties.dnsSettings"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetNetworkConfigurationDnsSettings"

    name

    name: "Composite" = "Composite"

    enableAcceleratedNetworking

    enableAcceleratedNetworking: object

    serializedName

    serializedName: string = "properties.enableAcceleratedNetworking"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    enableIPForwarding

    enableIPForwarding: object

    serializedName

    serializedName: string = "properties.enableIPForwarding"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    ipConfigurations

    ipConfigurations: object

    serializedName

    serializedName: string = "properties.ipConfigurations"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateIPConfiguration"

    name

    name: "Composite" = "Composite"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    networkSecurityGroup

    networkSecurityGroup: object

    serializedName

    serializedName: string = "properties.networkSecurityGroup"

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    primary

    primary: object

    serializedName

    serializedName: string = "properties.primary"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    Const VirtualMachineScaleSetUpdateNetworkProfile

    VirtualMachineScaleSetUpdateNetworkProfile: object

    Describes a virtual machine scale set network profile.

    Optional networkInterfaceConfigurations

    networkInterfaceConfigurations: VirtualMachineScaleSetUpdateNetworkConfiguration[]

    The list of network configurations.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdateNetworkProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateNetworkProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    networkInterfaceConfigurations

    networkInterfaceConfigurations: object

    serializedName

    serializedName: string = "networkInterfaceConfigurations"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateNetworkConfiguration"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetUpdateOSDisk

    VirtualMachineScaleSetUpdateOSDisk: object

    Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.

    Optional caching

    caching: CachingTypes

    The caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    Optional image

    The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist.

    Optional managedDisk

    The managed disk parameters.

    Optional vhdContainers

    vhdContainers: string[]

    The list of virtual hard disk container uris.

    Optional writeAcceleratorEnabled

    writeAcceleratorEnabled: undefined | false | true

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdateOSDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateOSDisk"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    caching

    caching: object

    serializedName

    serializedName: string = "caching"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["None","ReadOnly","ReadWrite"]

    name

    name: "Enum" = "Enum"

    image

    image: object

    serializedName

    serializedName: string = "image"

    type

    type: object

    className

    className: string = "VirtualHardDisk"

    name

    name: "Composite" = "Composite"

    managedDisk

    managedDisk: object

    serializedName

    serializedName: string = "managedDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetManagedDiskParameters"

    name

    name: "Composite" = "Composite"

    vhdContainers

    vhdContainers: object

    serializedName

    serializedName: string = "vhdContainers"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    writeAcceleratorEnabled

    writeAcceleratorEnabled: object

    serializedName

    serializedName: string = "writeAcceleratorEnabled"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    Const VirtualMachineScaleSetUpdateOSProfile

    VirtualMachineScaleSetUpdateOSProfile: object

    Describes a virtual machine scale set OS profile.

    Optional customData

    customData: undefined | string

    A base-64 encoded string of custom data.

    Optional linuxConfiguration

    linuxConfiguration: LinuxConfiguration

    The Linux Configuration of the OS profile.

    Optional secrets

    secrets: VaultSecretGroup[]

    The List of certificates for addition to the VM.

    Optional windowsConfiguration

    windowsConfiguration: WindowsConfiguration

    The Windows Configuration of the OS profile.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdateOSProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateOSProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    customData

    customData: object

    serializedName

    serializedName: string = "customData"

    type

    type: object

    name

    name: "String" = "String"

    linuxConfiguration

    linuxConfiguration: object

    serializedName

    serializedName: string = "linuxConfiguration"

    type

    type: object

    className

    className: string = "LinuxConfiguration"

    name

    name: "Composite" = "Composite"

    secrets

    secrets: object

    serializedName

    serializedName: string = "secrets"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VaultSecretGroup"

    name

    name: "Composite" = "Composite"

    windowsConfiguration

    windowsConfiguration: object

    serializedName

    serializedName: string = "windowsConfiguration"

    type

    type: object

    className

    className: string = "WindowsConfiguration"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetUpdatePublicIPAddressConfiguration

    VirtualMachineScaleSetUpdatePublicIPAddressConfiguration: object

    Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

    Optional dnsSettings

    The dns settings to be applied on the publicIP addresses .

    Optional idleTimeoutInMinutes

    idleTimeoutInMinutes: undefined | number

    The idle timeout of the public IP address.

    Optional name

    name: undefined | string

    The publicIP address configuration name.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dnsSettings

    dnsSettings: object

    serializedName

    serializedName: string = "properties.dnsSettings"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings"

    name

    name: "Composite" = "Composite"

    idleTimeoutInMinutes

    idleTimeoutInMinutes: object

    serializedName

    serializedName: string = "properties.idleTimeoutInMinutes"

    type

    type: object

    name

    name: "Number" = "Number"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetUpdateStorageProfile

    VirtualMachineScaleSetUpdateStorageProfile: object

    Describes a virtual machine scale set storage profile.

    Optional dataDisks

    The data disks.

    Optional imageReference

    imageReference: ImageReference

    The image reference.

    Optional osDisk

    The OS disk.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdateStorageProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateStorageProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    dataDisks

    dataDisks: object

    serializedName

    serializedName: string = "dataDisks"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetDataDisk"

    name

    name: "Composite" = "Composite"

    imageReference

    imageReference: object

    serializedName

    serializedName: string = "imageReference"

    type

    type: object

    className

    className: string = "ImageReference"

    name

    name: "Composite" = "Composite"

    osDisk

    osDisk: object

    serializedName

    serializedName: string = "osDisk"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateOSDisk"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetUpdateVMProfile

    VirtualMachineScaleSetUpdateVMProfile: object

    Describes a virtual machine scale set virtual machine profile.

    Optional diagnosticsProfile

    diagnosticsProfile: DiagnosticsProfile

    The virtual machine scale set diagnostics profile.

    Optional extensionProfile

    The virtual machine scale set extension profile.

    Optional licenseType

    licenseType: undefined | string

    The license type, which is for bring your own license scenario.

    Optional networkProfile

    The virtual machine scale set network profile.

    Optional osProfile

    The virtual machine scale set OS profile.

    Optional storageProfile

    The virtual machine scale set storage profile.

    serializedName

    serializedName: string = "VirtualMachineScaleSetUpdateVMProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateVMProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    diagnosticsProfile

    diagnosticsProfile: object

    serializedName

    serializedName: string = "diagnosticsProfile"

    type

    type: object

    className

    className: string = "DiagnosticsProfile"

    name

    name: "Composite" = "Composite"

    extensionProfile

    extensionProfile: object

    serializedName

    serializedName: string = "extensionProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetExtensionProfile"

    name

    name: "Composite" = "Composite"

    licenseType

    licenseType: object

    serializedName

    serializedName: string = "licenseType"

    type

    type: object

    name

    name: "String" = "String"

    networkProfile

    networkProfile: object

    serializedName

    serializedName: string = "networkProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateNetworkProfile"

    name

    name: "Composite" = "Composite"

    osProfile

    osProfile: object

    serializedName

    serializedName: string = "osProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateOSProfile"

    name

    name: "Composite" = "Composite"

    storageProfile

    storageProfile: object

    serializedName

    serializedName: string = "storageProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetUpdateStorageProfile"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetVM

    VirtualMachineScaleSetVM: object

    Describes a virtual machine scale set virtual machine.

    Optional availabilitySet

    availabilitySet: SubResource

    Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines.

    For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

    Optional diagnosticsProfile

    diagnosticsProfile: DiagnosticsProfile

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    Optional hardwareProfile

    hardwareProfile: HardwareProfile

    Specifies the hardware settings for the virtual machine.

    Optional id

    id: undefined | string

    Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

    Optional instanceId

    instanceId: undefined | string

    The virtual machine instance ID. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional instanceView

    The virtual machine instance view. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional latestModelApplied

    latestModelApplied: undefined | false | true

    Specifies whether the latest model has been applied to the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional licenseType

    licenseType: undefined | string

    Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see Azure Hybrid Use Benefit for Windows Server

    Minimum api-version: 2015-06-15

    location

    location: string

    Resource location

    Optional name

    name: undefined | string

    Resource name NOTE: This property will not be serialized. It can only be populated by the server.

    Optional networkProfile

    networkProfile: NetworkProfile

    Specifies the network interfaces of the virtual machine.

    Optional osProfile

    osProfile: OSProfile

    Specifies the operating system settings for the virtual machine.

    Optional plan

    plan: Plan

    Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

    Optional provisioningState

    provisioningState: undefined | string

    The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional resources

    The virtual machine child extension resources. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional sku

    sku: Sku

    The virtual machine SKU. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional storageProfile

    storageProfile: StorageProfile

    Specifies the storage settings for the virtual machine disks.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional vmId

    vmId: undefined | string

    Azure VM unique ID. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetVM"

    Optional type

    type: object

    Resource type NOTE: This property will not be serialized. It can only be populated by the server.

    className

    className: string = "VirtualMachineScaleSetVM"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    availabilitySet

    availabilitySet: object

    serializedName

    serializedName: string = "properties.availabilitySet"

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    diagnosticsProfile

    diagnosticsProfile: object

    serializedName

    serializedName: string = "properties.diagnosticsProfile"

    type

    type: object

    className

    className: string = "DiagnosticsProfile"

    name

    name: "Composite" = "Composite"

    hardwareProfile

    hardwareProfile: object

    serializedName

    serializedName: string = "properties.hardwareProfile"

    type

    type: object

    className

    className: string = "HardwareProfile"

    name

    name: "Composite" = "Composite"

    instanceId

    instanceId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "instanceId"

    type

    type: object

    name

    name: "String" = "String"

    instanceView

    instanceView: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.instanceView"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMInstanceView"

    name

    name: "Composite" = "Composite"

    latestModelApplied

    latestModelApplied: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.latestModelApplied"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    licenseType

    licenseType: object

    serializedName

    serializedName: string = "properties.licenseType"

    type

    type: object

    name

    name: "String" = "String"

    networkProfile

    networkProfile: object

    serializedName

    serializedName: string = "properties.networkProfile"

    type

    type: object

    className

    className: string = "NetworkProfile"

    name

    name: "Composite" = "Composite"

    osProfile

    osProfile: object

    serializedName

    serializedName: string = "properties.osProfile"

    type

    type: object

    className

    className: string = "OSProfile"

    name

    name: "Composite" = "Composite"

    plan

    plan: object

    serializedName

    serializedName: string = "plan"

    type

    type: object

    className

    className: string = "Plan"

    name

    name: "Composite" = "Composite"

    provisioningState

    provisioningState: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.provisioningState"

    type

    type: object

    name

    name: "String" = "String"

    resources

    resources: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "resources"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineExtension"

    name

    name: "Composite" = "Composite"

    sku

    sku: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "sku"

    type

    type: object

    className

    className: string = "Sku"

    name

    name: "Composite" = "Composite"

    storageProfile

    storageProfile: object

    serializedName

    serializedName: string = "properties.storageProfile"

    type

    type: object

    className

    className: string = "StorageProfile"

    name

    name: "Composite" = "Composite"

    vmId

    vmId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.vmId"

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetVMExtensionsSummary

    VirtualMachineScaleSetVMExtensionsSummary: object

    Extensions summary for virtual machines of a virtual machine scale set.

    Optional name

    name: undefined | string

    The extension name. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional statusesSummary

    The extensions information. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetVMExtensionsSummary"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMExtensionsSummary"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    name

    name: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    statusesSummary

    statusesSummary: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "statusesSummary"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineStatusCodeCount"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetVMInstanceIDs

    VirtualMachineScaleSetVMInstanceIDs: object

    Specifies a list of virtual machine instance IDs from the VM scale set.

    Optional instanceIds

    instanceIds: string[]

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    serializedName

    serializedName: string = "VirtualMachineScaleSetVMInstanceIDs"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMInstanceIDs"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    instanceIds

    instanceIds: object

    serializedName

    serializedName: string = "instanceIds"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetVMInstanceRequiredIDs

    VirtualMachineScaleSetVMInstanceRequiredIDs: object

    Specifies a list of virtual machine instance IDs from the VM scale set.

    instanceIds

    instanceIds: string[]

    The virtual machine scale set instance ids.

    serializedName

    serializedName: string = "VirtualMachineScaleSetVMInstanceRequiredIDs"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMInstanceRequiredIDs"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    instanceIds

    instanceIds: object

    required

    required: true = true

    serializedName

    serializedName: string = "instanceIds"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    Const VirtualMachineScaleSetVMInstanceView

    VirtualMachineScaleSetVMInstanceView: object

    The instance view of a virtual machine scale set VM.

    Optional bootDiagnostics

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.

    Optional disks

    The disks information.

    Optional extensions

    The extensions information.

    Optional maintenanceRedeployStatus

    maintenanceRedeployStatus: MaintenanceRedeployStatus

    The Maintenance Operation status on the virtual machine.

    Optional placementGroupId

    placementGroupId: undefined | string

    The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.

    Optional platformFaultDomain

    platformFaultDomain: undefined | number

    The Fault Domain count.

    Optional platformUpdateDomain

    platformUpdateDomain: undefined | number

    The Update Domain count.

    Optional rdpThumbPrint

    rdpThumbPrint: undefined | string

    The Remote desktop certificate thumbprint.

    Optional statuses

    statuses: InstanceViewStatus[]

    The resource status information.

    Optional vmAgent

    The VM Agent running on the virtual machine.

    Optional vmHealth

    The health status for the VM. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineScaleSetVMInstanceView"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMInstanceView"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    bootDiagnostics

    bootDiagnostics: object

    serializedName

    serializedName: string = "bootDiagnostics"

    type

    type: object

    className

    className: string = "BootDiagnosticsInstanceView"

    name

    name: "Composite" = "Composite"

    disks

    disks: object

    serializedName

    serializedName: string = "disks"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "DiskInstanceView"

    name

    name: "Composite" = "Composite"

    extensions

    extensions: object

    serializedName

    serializedName: string = "extensions"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineExtensionInstanceView"

    name

    name: "Composite" = "Composite"

    maintenanceRedeployStatus

    maintenanceRedeployStatus: object

    serializedName

    serializedName: string = "maintenanceRedeployStatus"

    type

    type: object

    className

    className: string = "MaintenanceRedeployStatus"

    name

    name: "Composite" = "Composite"

    placementGroupId

    placementGroupId: object

    serializedName

    serializedName: string = "placementGroupId"

    type

    type: object

    name

    name: "String" = "String"

    platformFaultDomain

    platformFaultDomain: object

    serializedName

    serializedName: string = "platformFaultDomain"

    type

    type: object

    name

    name: "Number" = "Number"

    platformUpdateDomain

    platformUpdateDomain: object

    serializedName

    serializedName: string = "platformUpdateDomain"

    type

    type: object

    name

    name: "Number" = "Number"

    rdpThumbPrint

    rdpThumbPrint: object

    serializedName

    serializedName: string = "rdpThumbPrint"

    type

    type: object

    name

    name: "String" = "String"

    statuses

    statuses: object

    serializedName

    serializedName: string = "statuses"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "InstanceViewStatus"

    name

    name: "Composite" = "Composite"

    vmAgent

    vmAgent: object

    serializedName

    serializedName: string = "vmAgent"

    type

    type: object

    className

    className: string = "VirtualMachineAgentInstanceView"

    name

    name: "Composite" = "Composite"

    vmHealth

    vmHealth: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "vmHealth"

    type

    type: object

    className

    className: string = "VirtualMachineHealthStatus"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetVMListResult

    VirtualMachineScaleSetVMListResult: object
    interface

    The List Virtual Machine Scale Set VMs operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Optional nextLink

    nextLink: undefined | string

    The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs

    serializedName

    serializedName: string = "VirtualMachineScaleSetVMListResult"

    __@iterator

    • Iterator

      Returns IterableIterator<VirtualMachineScaleSetVM>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      Returns VirtualMachineScaleSetVM[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns VirtualMachineScaleSetVM[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, VirtualMachineScaleSetVM]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    fill

    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: VirtualMachineScaleSetVM

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter<S>(callbackfn: function, thisArg?: any): S[]
    • filter(callbackfn: function, thisArg?: any): VirtualMachineScaleSetVM[]
    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns VirtualMachineScaleSetVM[]

    find

    • find<S>(predicate: function, thisArg?: any): S | undefined
    • find(predicate: function, thisArg?: any): VirtualMachineScaleSetVM | undefined
    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type parameters

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns S | undefined

    • Parameters

      Returns VirtualMachineScaleSetVM | undefined

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: VirtualMachineScaleSetVM

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSetVM

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: VirtualMachineScaleSetVM

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns VirtualMachineScaleSetVM | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    reduceRight

    reverse

    • Reverses the elements in an Array.

      Returns VirtualMachineScaleSetVM[]

    shift

    • Removes the first element from an array and returns it.

      Returns VirtualMachineScaleSetVM | undefined

    slice

    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns VirtualMachineScaleSetVM[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns VirtualMachineScaleSetVM[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: VirtualMachineScaleSetVM[]

        Elements to insert into the array in place of the deleted elements.

      Returns VirtualMachineScaleSetVM[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<VirtualMachineScaleSetVM>

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMListResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    nextLink

    nextLink: object

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    value

    value: object

    required

    required: true = true

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVM"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineScaleSetVMProfile

    VirtualMachineScaleSetVMProfile: object

    Describes a virtual machine scale set virtual machine profile.

    Optional diagnosticsProfile

    diagnosticsProfile: DiagnosticsProfile

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    Optional evictionPolicy

    Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview. Possible values include: 'Deallocate', 'Delete'

    Optional extensionProfile

    Specifies a collection of settings for extensions installed on virtual machines in the scale set.

    Optional licenseType

    licenseType: undefined | string

    Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see Azure Hybrid Use Benefit for Windows Server

    Minimum api-version: 2015-06-15

    Optional networkProfile

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    Optional osProfile

    Specifies the operating system settings for the virtual machines in the scale set.

    Optional priority

    Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview. Possible values include: 'Regular', 'Low'

    Optional storageProfile

    Specifies the storage settings for the virtual machine disks.

    serializedName

    serializedName: string = "VirtualMachineScaleSetVMProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetVMProfile"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    diagnosticsProfile

    diagnosticsProfile: object

    serializedName

    serializedName: string = "diagnosticsProfile"

    type

    type: object

    className

    className: string = "DiagnosticsProfile"

    name

    name: "Composite" = "Composite"

    evictionPolicy

    evictionPolicy: object

    serializedName

    serializedName: string = "evictionPolicy"

    type

    type: object

    name

    name: "String" = "String"

    extensionProfile

    extensionProfile: object

    serializedName

    serializedName: string = "extensionProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetExtensionProfile"

    name

    name: "Composite" = "Composite"

    licenseType

    licenseType: object

    serializedName

    serializedName: string = "licenseType"

    type

    type: object

    name

    name: "String" = "String"

    networkProfile

    networkProfile: object

    serializedName

    serializedName: string = "networkProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetNetworkProfile"

    name

    name: "Composite" = "Composite"

    osProfile

    osProfile: object

    serializedName

    serializedName: string = "osProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetOSProfile"

    name

    name: "Composite" = "Composite"

    priority

    priority: object

    serializedName

    serializedName: string = "priority"

    type

    type: object

    name

    name: "String" = "String"

    storageProfile

    storageProfile: object

    serializedName

    serializedName: string = "storageProfile"

    type

    type: object

    className

    className: string = "VirtualMachineScaleSetStorageProfile"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineSize

    VirtualMachineSize: object

    Describes the properties of a VM size.

    Optional maxDataDiskCount

    maxDataDiskCount: undefined | number

    The maximum number of data disks that can be attached to the virtual machine size.

    Optional memoryInMB

    memoryInMB: undefined | number

    The amount of memory, in MB, supported by the virtual machine size.

    Optional name

    name: undefined | string

    The name of the virtual machine size.

    Optional numberOfCores

    numberOfCores: undefined | number

    The number of cores supported by the virtual machine size.

    Optional osDiskSizeInMB

    osDiskSizeInMB: undefined | number

    The OS disk size, in MB, allowed by the virtual machine size.

    Optional resourceDiskSizeInMB

    resourceDiskSizeInMB: undefined | number

    The resource disk size, in MB, allowed by the virtual machine size.

    serializedName

    serializedName: string = "VirtualMachineSize"

    type

    type: object

    className

    className: string = "VirtualMachineSize"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    maxDataDiskCount

    maxDataDiskCount: object

    serializedName

    serializedName: string = "maxDataDiskCount"

    type

    type: object

    name

    name: "Number" = "Number"

    memoryInMB

    memoryInMB: object

    serializedName

    serializedName: string = "memoryInMB"

    type

    type: object

    name

    name: "Number" = "Number"

    name

    name: object

    serializedName

    serializedName: string = "name"

    type

    type: object

    name

    name: "String" = "String"

    numberOfCores

    numberOfCores: object

    serializedName

    serializedName: string = "numberOfCores"

    type

    type: object

    name

    name: "Number" = "Number"

    osDiskSizeInMB

    osDiskSizeInMB: object

    serializedName

    serializedName: string = "osDiskSizeInMB"

    type

    type: object

    name

    name: "Number" = "Number"

    resourceDiskSizeInMB

    resourceDiskSizeInMB: object

    serializedName

    serializedName: string = "resourceDiskSizeInMB"

    type

    type: object

    name

    name: "Number" = "Number"

    Const VirtualMachineSizeListResult

    VirtualMachineSizeListResult: object
    interface

    The List Virtual Machine operation response.

    extends

    Array

    Array

    Array: ArrayConstructor

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    serializedName

    serializedName: string = "VirtualMachineSizeListResult"

    __@iterator

    • Iterator

      Returns IterableIterator<VirtualMachineSize>

    __@unscopables

    • __@unscopables(): object
    • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      Returns object

    concat

    • Combines two or more arrays.

      Parameters

      • Rest ...items: ConcatArray<VirtualMachineSize>[]

        Additional items to add to the end of array1.

      Returns VirtualMachineSize[]

    • Combines two or more arrays.

      Parameters

      • Rest ...items: (T | ConcatArray<T>)[]

        Additional items to add to the end of array1.

      Returns VirtualMachineSize[]

    copyWithin

    • copyWithin(target: number, start: number, end?: undefined | number): this
    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: undefined | number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, VirtualMachineSize]>

    every

    • every(callbackfn: function, thisArg?: any): boolean
    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    fill

    • fill(value: VirtualMachineSize, start?: undefined | number, end?: undefined | number): this
    • Returns the this object after filling the section identified by start and end with value

      Parameters

      • value: VirtualMachineSize

        value to fill array section with

      • Optional start: undefined | number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optional end: undefined | number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter<S>(callbackfn: function, thisArg?: any): S[]
    • filter(callbackfn: function, thisArg?: any): VirtualMachineSize[]
    • Returns the elements of an array that meet the condition specified in a callback function.

      Type parameters

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns S[]

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns VirtualMachineSize[]

    find

    • find<S>(predicate: function, thisArg?: any): S | undefined
    • find(predicate: function, thisArg?: any): VirtualMachineSize | undefined
    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type parameters

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns S | undefined

    • Parameters

      Returns VirtualMachineSize | undefined

    findIndex

    • findIndex(predicate: function, thisArg?: any): number
    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: function

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    forEach

    • forEach(callbackfn: function, thisArg?: any): void
    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: VirtualMachineSize

        The element to search for.

      • Optional fromIndex: undefined | number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: VirtualMachineSize

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    join

    • join(separator?: undefined | string): string
    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optional separator: undefined | string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    keys

    • keys(): IterableIterator<number>
    • Returns an iterable of keys in the array

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a specified value in an array.

      Parameters

      • searchElement: VirtualMachineSize

        The value to locate in the array.

      • Optional fromIndex: undefined | number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

      Returns number

    map

    • map<U>(callbackfn: function, thisArg?: any): U[]
    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns U[]

    pop

    • Removes the last element from an array and returns it.

      Returns VirtualMachineSize | undefined

    push

    • Appends new elements to an array, and returns the new length of the array.

      Parameters

      Returns number

    reduce

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      Returns VirtualMachineSize

    • Parameters

      Returns VirtualMachineSize

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    reduceRight

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      Returns VirtualMachineSize

    • Parameters

      Returns VirtualMachineSize

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type parameters

      • U

      Parameters

      • callbackfn: function

        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    reverse

    • Reverses the elements in an Array.

      Returns VirtualMachineSize[]

    shift

    • Removes the first element from an array and returns it.

      Returns VirtualMachineSize | undefined

    slice

    • Returns a section of an array.

      Parameters

      • Optional start: undefined | number

        The beginning of the specified portion of the array.

      • Optional end: undefined | number

        The end of the specified portion of the array.

      Returns VirtualMachineSize[]

    some

    • some(callbackfn: function, thisArg?: any): boolean
    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • callbackfn: function

        A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    sort

    • sort(compareFn?: undefined | function): this
    • Sorts an array.

      Parameters

      • Optional compareFn: undefined | function

        The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

      Returns this

    splice

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • Optional deleteCount: undefined | number

        The number of elements to remove.

      Returns VirtualMachineSize[]

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

      • deleteCount: number

        The number of elements to remove.

      • Rest ...items: VirtualMachineSize[]

        Elements to insert into the array in place of the deleted elements.

      Returns VirtualMachineSize[]

    toLocaleString

    • toLocaleString(): string
    • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

      Returns string

    toString

    • toString(): string
    • Returns a string representation of an array.

      Returns string

    unshift

    • Inserts new elements at the start of an array.

      Parameters

      Returns number

    values

    • Returns an iterable of values in the array

      Returns IterableIterator<VirtualMachineSize>

    type

    type: object

    className

    className: string = "VirtualMachineSizeListResult"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    value

    value: object

    serializedName

    serializedName: string = ""

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "VirtualMachineSize"

    name

    name: "Composite" = "Composite"

    Const VirtualMachineStatusCodeCount

    VirtualMachineStatusCodeCount: object

    The status code and count of the virtual machine scale set instance view status summary.

    Optional code

    code: undefined | string

    The instance view status code. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional count

    count: undefined | number

    The number of instances having a particular status code. NOTE: This property will not be serialized. It can only be populated by the server.

    serializedName

    serializedName: string = "VirtualMachineStatusCodeCount"

    type

    type: object

    className

    className: string = "VirtualMachineStatusCodeCount"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    code

    code: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "code"

    type

    type: object

    name

    name: "String" = "String"

    count

    count: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "count"

    type

    type: object

    name

    name: "Number" = "Number"

    Const VirtualMachineUpdate

    VirtualMachineUpdate: object

    Describes a Virtual Machine Update.

    Optional availabilitySet

    availabilitySet: SubResource

    Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines.

    For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

    Optional diagnosticsProfile

    diagnosticsProfile: DiagnosticsProfile

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    Optional hardwareProfile

    hardwareProfile: HardwareProfile

    Specifies the hardware settings for the virtual machine.

    Optional identity

    The identity of the virtual machine, if configured.

    Optional instanceView

    The virtual machine instance view. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional licenseType

    licenseType: undefined | string

    Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see Azure Hybrid Use Benefit for Windows Server

    Minimum api-version: 2015-06-15

    Optional networkProfile

    networkProfile: NetworkProfile

    Specifies the network interfaces of the virtual machine.

    Optional osProfile

    osProfile: OSProfile

    Specifies the operating system settings for the virtual machine.

    Optional plan

    plan: Plan

    Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

    Optional provisioningState

    provisioningState: undefined | string

    The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional storageProfile

    storageProfile: StorageProfile

    Specifies the storage settings for the virtual machine disks.

    Optional tags

    tags: undefined | object

    Resource tags

    Optional vmId

    vmId: undefined | string

    Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. NOTE: This property will not be serialized. It can only be populated by the server.

    Optional zones

    zones: string[]

    The virtual machine zones.

    serializedName

    serializedName: string = "VirtualMachineUpdate"

    type

    type: object

    className

    className: string = "VirtualMachineUpdate"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    availabilitySet

    availabilitySet: object

    serializedName

    serializedName: string = "properties.availabilitySet"

    type

    type: object

    className

    className: string = "SubResource"

    name

    name: "Composite" = "Composite"

    diagnosticsProfile

    diagnosticsProfile: object

    serializedName

    serializedName: string = "properties.diagnosticsProfile"

    type

    type: object

    className

    className: string = "DiagnosticsProfile"

    name

    name: "Composite" = "Composite"

    hardwareProfile

    hardwareProfile: object

    serializedName

    serializedName: string = "properties.hardwareProfile"

    type

    type: object

    className

    className: string = "HardwareProfile"

    name

    name: "Composite" = "Composite"

    identity

    identity: object

    serializedName

    serializedName: string = "identity"

    type

    type: object

    className

    className: string = "VirtualMachineIdentity"

    name

    name: "Composite" = "Composite"

    instanceView

    instanceView: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.instanceView"

    type

    type: object

    className

    className: string = "VirtualMachineInstanceView"

    name

    name: "Composite" = "Composite"

    licenseType

    licenseType: object

    serializedName

    serializedName: string = "properties.licenseType"

    type

    type: object

    name

    name: "String" = "String"

    networkProfile

    networkProfile: object

    serializedName

    serializedName: string = "properties.networkProfile"

    type

    type: object

    className

    className: string = "NetworkProfile"

    name

    name: "Composite" = "Composite"

    osProfile

    osProfile: object

    serializedName

    serializedName: string = "properties.osProfile"

    type

    type: object

    className

    className: string = "OSProfile"

    name

    name: "Composite" = "Composite"

    plan

    plan: object

    serializedName

    serializedName: string = "plan"

    type

    type: object

    className

    className: string = "Plan"

    name

    name: "Composite" = "Composite"

    provisioningState

    provisioningState: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.provisioningState"

    type

    type: object

    name

    name: "String" = "String"

    storageProfile

    storageProfile: object

    serializedName

    serializedName: string = "properties.storageProfile"

    type

    type: object

    className

    className: string = "StorageProfile"

    name

    name: "Composite" = "Composite"

    vmId

    vmId: object

    readOnly

    readOnly: true = true

    serializedName

    serializedName: string = "properties.vmId"

    type

    type: object

    name

    name: "String" = "String"

    zones

    zones: object

    serializedName

    serializedName: string = "zones"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    name

    name: "String" = "String"

    Const WinRMConfiguration

    WinRMConfiguration: object

    Describes Windows Remote Management configuration of the VM

    Optional listeners

    listeners: WinRMListener[]

    The list of Windows Remote Management listeners

    serializedName

    serializedName: string = "WinRMConfiguration"

    type

    type: object

    className

    className: string = "WinRMConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    listeners

    listeners: object

    serializedName

    serializedName: string = "listeners"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "WinRMListener"

    name

    name: "Composite" = "Composite"

    Const WinRMListener

    WinRMListener: object

    Describes Protocol and thumbprint of Windows Remote Management listener

    Optional certificateUrl

    certificateUrl: undefined | string

    This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

    {
    "data":"",
    "dataType":"pfx",
    "password":""
    }

    Optional protocol

    protocol: ProtocolTypes

    Specifies the protocol of listener.

    Possible values are:
    http

    https. Possible values include: 'Http', 'Https'

    serializedName

    serializedName: string = "WinRMListener"

    type

    type: object

    className

    className: string = "WinRMListener"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    certificateUrl

    certificateUrl: object

    serializedName

    serializedName: string = "certificateUrl"

    type

    type: object

    name

    name: "String" = "String"

    protocol

    protocol: object

    serializedName

    serializedName: string = "protocol"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["Http","Https"]

    name

    name: "Enum" = "Enum"

    Const WindowsConfiguration

    WindowsConfiguration: object

    Specifies Windows operating system settings on the virtual machine.

    Optional additionalUnattendContent

    additionalUnattendContent: AdditionalUnattendContent[]

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    Optional enableAutomaticUpdates

    enableAutomaticUpdates: undefined | false | true

    Indicates whether virtual machine is enabled for automatic updates.

    Optional provisionVMAgent

    provisionVMAgent: undefined | false | true

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    Optional timeZone

    timeZone: undefined | string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    Optional winRM

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    serializedName

    serializedName: string = "WindowsConfiguration"

    type

    type: object

    className

    className: string = "WindowsConfiguration"

    name

    name: "Composite" = "Composite"

    modelProperties

    modelProperties: object

    additionalUnattendContent

    additionalUnattendContent: object

    serializedName

    serializedName: string = "additionalUnattendContent"

    type

    type: object

    name

    name: "Sequence" = "Sequence"

    element

    element: object

    type

    type: object

    className

    className: string = "AdditionalUnattendContent"

    name

    name: "Composite" = "Composite"

    enableAutomaticUpdates

    enableAutomaticUpdates: object

    serializedName

    serializedName: string = "enableAutomaticUpdates"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    provisionVMAgent

    provisionVMAgent: object

    serializedName

    serializedName: string = "provisionVMAgent"

    type

    type: object

    name

    name: "Boolean" = "Boolean"

    timeZone

    timeZone: object

    serializedName

    serializedName: string = "timeZone"

    type

    type: object

    name

    name: "String" = "String"

    winRM

    winRM: object

    serializedName

    serializedName: string = "winRM"

    type

    type: object

    className

    className: string = "WinRMConfiguration"

    name

    name: "Composite" = "Composite"

    Const acceptLanguage

    acceptLanguage: object

    parameterPath

    parameterPath: string = "acceptLanguage"

    mapper

    mapper: object

    defaultValue

    defaultValue: string = "en-US"

    serializedName

    serializedName: string = "accept-language"

    type

    type: object

    name

    name: "String" = "String"

    Const apiVersion0

    apiVersion0: object

    parameterPath

    parameterPath: string = "apiVersion"

    mapper

    mapper: object

    defaultValue

    defaultValue: string = "2017-12-01"

    isConstant

    isConstant: true = true

    required

    required: true = true

    serializedName

    serializedName: string = "api-version"

    type

    type: object

    name

    name: "String" = "String"

    Const apiVersion1

    apiVersion1: object

    parameterPath

    parameterPath: string = "apiVersion"

    mapper

    mapper: object

    defaultValue

    defaultValue: string = "2017-03-30"

    isConstant

    isConstant: true = true

    required

    required: true = true

    serializedName

    serializedName: string = "api-version"

    type

    type: object

    name

    name: "String" = "String"

    Const availabilitySetName

    availabilitySetName: object

    parameterPath

    parameterPath: string = "availabilitySetName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "availabilitySetName"

    type

    type: object

    name

    name: "String" = "String"

    Const diskName

    diskName: object

    parameterPath

    parameterPath: string = "diskName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "diskName"

    type

    type: object

    name

    name: "String" = "String"

    Const expand0

    expand0: object

    parameterPath

    parameterPath: string[] = ["options","expand"]

    mapper

    mapper: object

    serializedName

    serializedName: string = "$expand"

    type

    type: object

    name

    name: "String" = "String"

    Const expand1

    expand1: object

    parameterPath

    parameterPath: string[] = ["options","expand"]

    mapper

    mapper: object

    serializedName

    serializedName: string = "$expand"

    type

    type: object

    allowedValues

    allowedValues: string[] = ["instanceView"]

    name

    name: "Enum" = "Enum"

    Const filter

    filter: object

    parameterPath

    parameterPath: string[] = ["options","filter"]

    mapper

    mapper: object

    serializedName

    serializedName: string = "$filter"

    type

    type: object

    name

    name: "String" = "String"

    Const imageName

    imageName: object

    parameterPath

    parameterPath: string = "imageName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "imageName"

    type

    type: object

    name

    name: "String" = "String"

    Const instanceId

    instanceId: object

    parameterPath

    parameterPath: string = "instanceId"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "instanceId"

    type

    type: object

    name

    name: "String" = "String"

    Const location0

    location0: object

    parameterPath

    parameterPath: string = "location"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "location"

    type

    type: object

    name

    name: "String" = "String"

    Const location1

    location1: object

    parameterPath

    parameterPath: string = "location"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "location"

    constraints

    constraints: object

    Pattern

    Pattern: RegExp = /^[-\w\._]+$/

    type

    type: object

    name

    name: "String" = "String"

    Const nextPageLink

    nextPageLink: object

    parameterPath

    parameterPath: string = "nextPageLink"

    skipEncoding

    skipEncoding: true = true

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "nextLink"

    type

    type: object

    name

    name: "String" = "String"

    Const offer

    offer: object

    parameterPath

    parameterPath: string = "offer"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "offer"

    type

    type: object

    name

    name: "String" = "String"

    Const orderby

    orderby: object

    parameterPath

    parameterPath: string[] = ["options","orderby"]

    mapper

    mapper: object

    serializedName

    serializedName: string = "$orderby"

    type

    type: object

    name

    name: "String" = "String"

    Const platformUpdateDomain

    platformUpdateDomain: object

    parameterPath

    parameterPath: string = "platformUpdateDomain"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "platformUpdateDomain"

    type

    type: object

    name

    name: "Number" = "Number"

    Const publisherName

    publisherName: object

    parameterPath

    parameterPath: string = "publisherName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "publisherName"

    type

    type: object

    name

    name: "String" = "String"

    Const resourceGroupName

    resourceGroupName: object

    parameterPath

    parameterPath: string = "resourceGroupName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "resourceGroupName"

    type

    type: object

    name

    name: "String" = "String"

    Const select

    select: object

    parameterPath

    parameterPath: string[] = ["options","select"]

    mapper

    mapper: object

    serializedName

    serializedName: string = "$select"

    type

    type: object

    name

    name: "String" = "String"

    Const skus

    skus: object

    parameterPath

    parameterPath: string = "skus"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "skus"

    type

    type: object

    name

    name: "String" = "String"

    Const snapshotName

    snapshotName: object

    parameterPath

    parameterPath: string = "snapshotName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "snapshotName"

    type

    type: object

    name

    name: "String" = "String"

    Const subscriptionId

    subscriptionId: object

    parameterPath

    parameterPath: string = "subscriptionId"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "subscriptionId"

    type

    type: object

    name

    name: "String" = "String"

    Const top

    top: object

    parameterPath

    parameterPath: string[] = ["options","top"]

    mapper

    mapper: object

    serializedName

    serializedName: string = "$top"

    type

    type: object

    name

    name: "Number" = "Number"

    Const type

    type: object

    parameterPath

    parameterPath: string = "type"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "type"

    type

    type: object

    name

    name: "String" = "String"

    Const version

    version: object

    parameterPath

    parameterPath: string = "version"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "version"

    type

    type: object

    name

    name: "String" = "String"

    Const virtualMachineScaleSetName

    virtualMachineScaleSetName: object

    parameterPath

    parameterPath: string = "virtualMachineScaleSetName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "virtualMachineScaleSetName"

    type

    type: object

    name

    name: "String" = "String"

    Const vmExtensionName

    vmExtensionName: object

    parameterPath

    parameterPath: string = "vmExtensionName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "vmExtensionName"

    type

    type: object

    name

    name: "String" = "String"

    Const vmName

    vmName: object

    parameterPath

    parameterPath: string = "vmName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "vmName"

    type

    type: object

    name

    name: "String" = "String"

    Const vmScaleSetName

    vmScaleSetName: object

    parameterPath

    parameterPath: string = "vmScaleSetName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "vmScaleSetName"

    type

    type: object

    name

    name: "String" = "String"

    Const vmssExtensionName

    vmssExtensionName: object

    parameterPath

    parameterPath: string = "vmssExtensionName"

    mapper

    mapper: object

    required

    required: true = true

    serializedName

    serializedName: string = "vmssExtensionName"

    type

    type: object

    name

    name: "String" = "String"

    Generated using TypeDoc